otf-api 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

otf_api/models/responses/bookings.py

@@ -1,13 +1,89 @@
 from datetime import datetime
+from enum import Enum
+from typing import ClassVar
 
+from inflection import humanize
 from pydantic import Field
+from rich.style import Style
+from rich.styled import Styled
+from rich.table import Table
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase, OtfListBase
+from otf_api.models.responses.classes import OtfClassTimeMixin
 
-from .enums import BookingStatus, StudioStatus
 
+class StudioStatus(str, Enum):
+    OTHER = "OTHER"
+    ACTIVE = "Active"
+    INACTIVE = "Inactive"
+    COMING_SOON = "Coming Soon"
+    TEMP_CLOSED = "Temporarily Closed"
+    PERM_CLOSED = "Permanently Closed"
 
-class Location(OtfBaseModel):
+    @classmethod
+    def all_statuses(cls) -> list[str]:
+        return list(cls.__members__.values())
+
+
+class BookingStatus(str, Enum):
+    CheckedIn = "Checked In"
+    CancelCheckinPending = "Cancel Checkin Pending"
+    CancelCheckinRequested = "Cancel Checkin Requested"
+    Cancelled = "Cancelled"
+    LateCancelled = "Late Cancelled"
+    Booked = "Booked"
+    Waitlisted = "Waitlisted"
+    CheckinPending = "Checkin Pending"
+    CheckinRequested = "Checkin Requested"
+    CheckinCancelled = "Checkin Cancelled"
+
+    @classmethod
+    def get_from_key_insensitive(cls, key: str) -> "BookingStatus":
+        lcase_to_actual = {item.lower(): item for item in cls._member_map_}
+        val = cls.__members__.get(lcase_to_actual[key.lower()])
+        if not val:
+            raise ValueError(f"Invalid BookingStatus: {key}")
+        return val
+
+    @classmethod
+    def get_case_insensitive(cls, value: str) -> str:
+        lcase_to_actual = {item.value.lower(): item.value for item in cls}
+        return lcase_to_actual[value.lower()]
+
+    @classmethod
+    def all_statuses(cls) -> list[str]:
+        return list(cls.__members__.values())
+
+
+class BookingStatusCli(str, Enum):
+    """Flipped enum so that the CLI does not have values with spaces"""
+
+    CheckedIn = "CheckedIn"
+    CancelCheckinPending = "CancelCheckinPending"
+    CancelCheckinRequested = "CancelCheckinRequested"
+    Cancelled = "Cancelled"
+    LateCancelled = "LateCancelled"
+    Booked = "Booked"
+    Waitlisted = "Waitlisted"
+    CheckinPending = "CheckinPending"
+    CheckinRequested = "CheckinRequested"
+    CheckinCancelled = "CheckinCancelled"
+
+    @classmethod
+    def to_standard_case_insensitive(cls, key: str) -> BookingStatus:
+        lcase_to_actual = {item.lower(): item for item in cls._member_map_}
+        val = cls.__members__.get(lcase_to_actual[key.lower()])
+        if not val:
+            raise ValueError(f"Invalid BookingStatus: {key}")
+        return BookingStatus(val)
+
+    @classmethod
+    def get_case_insensitive(cls, value: str) -> str:
+        lcase_to_actual = {item.value.lower(): item.value for item in cls}
+        return lcase_to_actual[value.lower()]
+
+
+class Location(OtfItemBase):
     address_one: str = Field(alias="address1")
     address_two: str | None = Field(alias="address2")
     city: str
@@ -21,30 +97,30 @@ class Location(OtfBaseModel):
     state: str | None = None
 
 
-class Coach(OtfBaseModel):
+class Coach(OtfItemBase):
     coach_uuid: str = Field(alias="coachUUId")
     name: str
     first_name: str = Field(alias="firstName")
     last_name: str = Field(alias="lastName")
-    image_url: str = Field(alias="imageUrl")
-    profile_picture_url: str | None = Field(None, alias="profilePictureUrl")
+    image_url: str = Field(alias="imageUrl", exclude=True)
+    profile_picture_url: str | None = Field(None, alias="profilePictureUrl", exclude=True)
 
 
-class Currency(OtfBaseModel):
+class Currency(OtfItemBase):
     currency_alphabetic_code: str = Field(alias="currencyAlphabeticCode")
 
 
-class DefaultCurrency(OtfBaseModel):
+class DefaultCurrency(OtfItemBase):
     currency_id: int = Field(alias="currencyId")
     currency: Currency
 
 
-class StudioLocationCountry(OtfBaseModel):
+class StudioLocationCountry(OtfItemBase):
     country_currency_code: str = Field(alias="countryCurrencyCode")
     default_currency: DefaultCurrency = Field(alias="defaultCurrency")
 
 
-class StudioLocation(OtfBaseModel):
+class StudioLocation(OtfItemBase):
     latitude: float = Field(alias="latitude")
     longitude: float = Field(alias="longitude")
     phone_number: str = Field(alias="phoneNumber")
@@ -53,33 +129,33 @@ class StudioLocation(OtfBaseModel):
     physical_address2: str | None = Field(alias="physicalAddress2")
     physical_state: str = Field(alias="physicalState")
     physical_postal_code: str = Field(alias="physicalPostalCode")
-    physical_region: str = Field(alias="physicalRegion")
-    physical_country_id: int = Field(alias="physicalCountryId")
+    physical_region: str = Field(alias="physicalRegion", exclude=True)
+    physical_country_id: int = Field(alias="physicalCountryId", exclude=True)
     physical_country: str = Field(alias="physicalCountry")
-    country: StudioLocationCountry = Field(alias="country")
+    country: StudioLocationCountry = Field(alias="country", exclude=True)
 
 
-class Studio(OtfBaseModel):
+class Studio(OtfItemBase):
     studio_uuid: str = Field(alias="studioUUId")
     studio_name: str = Field(alias="studioName")
-    description: str
-    contact_email: str = Field(alias="contactEmail")
+    description: str | None = None
+    contact_email: str = Field(alias="contactEmail", exclude=True)
     status: StudioStatus
-    logo_url: str | None = Field(alias="logoUrl")
+    logo_url: str | None = Field(alias="logoUrl", exclude=True)
     time_zone: str = Field(alias="timeZone")
-    mbo_studio_id: int = Field(alias="mboStudioId")
+    mbo_studio_id: int = Field(alias="mboStudioId", exclude=True)
     studio_id: int = Field(alias="studioId")
     allows_cr_waitlist: bool | None = Field(None, alias="allowsCRWaitlist")
-    cr_waitlist_flag_last_updated: datetime = Field(alias="crWaitlistFlagLastUpdated")
-    studio_location: StudioLocation = Field(alias="studioLocation")
+    cr_waitlist_flag_last_updated: datetime = Field(alias="crWaitlistFlagLastUpdated", exclude=True)
+    studio_location: StudioLocation = Field(alias="studioLocation", exclude=True)
 
 
-class OtfClass(OtfBaseModel):
+class OtfClass(OtfItemBase, OtfClassTimeMixin):
     class_uuid: str = Field(alias="classUUId")
     name: str
-    description: str
-    start_date_time: datetime = Field(alias="startDateTime")
-    end_date_time: datetime = Field(alias="endDateTime")
+    description: str | None = Field(None, exclude=True)
+    starts_at_local: datetime = Field(alias="startDateTime")
+    ends_at_local: datetime = Field(alias="endDateTime")
     is_available: bool = Field(alias="isAvailable")
     is_cancelled: bool = Field(alias="isCancelled")
     program_name: str = Field(alias="programName")
@@ -89,42 +165,140 @@ class OtfClass(OtfBaseModel):
     location: Location
     virtual_class: bool | None = Field(None, alias="virtualClass")
 
+    @classmethod
+    def attr_to_column_header(cls, attr: str) -> str:
+        attr_map = {k: humanize(k) for k in cls.model_fields}
+        overrides = {
+            "day_of_week": "Class DoW",
+            "date": "Class Date",
+            "time": "Class Time",
+            "duration": "Class Duration",
+            "name": "Class Name",
+            "is_home_studio": "Home Studio",
+            "is_booked": "Booked",
+        }
+
+        attr_map.update(overrides)
+
+        return attr_map.get(attr, attr)
+
 
-class Member(OtfBaseModel):
+class Member(OtfItemBase):
     member_uuid: str = Field(alias="memberUUId")
     first_name: str = Field(alias="firstName")
     last_name: str = Field(alias="lastName")
     email: str
     phone_number: str = Field(alias="phoneNumber")
     gender: str
-    cc_last_4: str = Field(alias="ccLast4")
+    cc_last_4: str = Field(alias="ccLast4", exclude=True)
 
 
-class Booking(OtfBaseModel):
+class Booking(OtfItemBase):
     class_booking_id: int = Field(alias="classBookingId")
     class_booking_uuid: str = Field(alias="classBookingUUId")
     studio_id: int = Field(alias="studioId")
     class_id: int = Field(alias="classId")
     is_intro: bool = Field(alias="isIntro")
     member_id: int = Field(alias="memberId")
-    mbo_member_id: str = Field(alias="mboMemberId")
-    mbo_class_id: int = Field(alias="mboClassId")
-    mbo_visit_id: int | None = Field(None, alias="mboVisitId")
-    mbo_waitlist_entry_id: int | None = Field(alias="mboWaitlistEntryId")
-    mbo_sync_message: str | None = Field(alias="mboSyncMessage")
+    mbo_member_id: str = Field(alias="mboMemberId", exclude=True)
+    mbo_class_id: int = Field(alias="mboClassId", exclude=True)
+    mbo_visit_id: int | None = Field(None, alias="mboVisitId", exclude=True)
+    mbo_waitlist_entry_id: int | None = Field(alias="mboWaitlistEntryId", exclude=True)
+    mbo_sync_message: str | None = Field(alias="mboSyncMessage", exclude=True)
     status: BookingStatus
     booked_date: datetime | None = Field(None, alias="bookedDate")
     checked_in_date: datetime | None = Field(alias="checkedInDate")
     cancelled_date: datetime | None = Field(alias="cancelledDate")
-    created_by: str = Field(alias="createdBy")
+    created_by: str = Field(alias="createdBy", exclude=True)
     created_date: datetime = Field(alias="createdDate")
-    updated_by: str = Field(alias="updatedBy")
+    updated_by: str = Field(alias="updatedBy", exclude=True)
     updated_date: datetime = Field(alias="updatedDate")
     is_deleted: bool = Field(alias="isDeleted")
-    member: Member
+    member: Member = Field(exclude=True)
     waitlist_position: int | None = Field(None, alias="waitlistPosition")
-    class_: OtfClass | None = Field(None, alias="class")
+    otf_class: OtfClass = Field(alias="class")
+    is_home_studio: bool | None = Field(None, description="Custom helper field to determine if at home studio")
 
+    @property
+    def id_val(self) -> str:
+        return self.class_booking_id
 
-class BookingList(OtfBaseModel):
+    @property
+    def sidebar_data(self) -> Table:
+        data = {
+            "date": self.otf_class.date,
+            "class_name": self.otf_class.name,
+            "description": self.otf_class.description,
+            "class_id": self.id_val,
+            "studio_address": self.otf_class.studio.studio_location.physical_address,
+            "coach_name": self.otf_class.coach.name,
+        }
+
+        table = Table(expand=True, show_header=False, show_footer=False)
+        table.add_column("Key", style="cyan", ratio=1)
+        table.add_column("Value", style="magenta", ratio=2)
+
+        for key, value in data.items():
+            if value is False:
+                table.add_row(key, Styled(str(value), style="red"))
+            else:
+                table.add_row(key, str(value))
+
+        return table
+
+    def get_style(self, is_selected: bool = False) -> Style:
+        style = super().get_style(is_selected)
+        if self.status == BookingStatus.Cancelled:
+            style = Style(color="red")
+        elif self.status == BookingStatus.Waitlisted:
+            style = Style(color="yellow")
+        elif self.status == BookingStatus.CheckedIn and is_selected:
+            style = Style(color="blue", strike=True)
+        elif self.status == BookingStatus.CheckedIn:
+            style = Style(color="grey58")
+
+        return style
+
+    @classmethod
+    def attr_to_column_header(cls, attr: str) -> str:
+        if attr.startswith("otf_class"):
+            return OtfClass.attr_to_column_header(attr.split(".")[-1])
+
+        attr_map = {k: humanize(k) for k in cls.model_fields}
+        overrides = {
+            "day_of_week": "Class DoW",
+            "date": "Class Date",
+            "time": "Class Time",
+            "duration": "Class Duration",
+            "name": "Class Name",
+            "is_home_studio": "Home Studio",
+            "is_booked": "Booked",
+        }
+
+        attr_map.update(overrides)
+
+        return attr_map.get(attr, attr)
+
+
+class BookingList(OtfListBase):
+    collection_field: ClassVar[str] = "bookings"
     bookings: list[Booking]
+
+    @staticmethod
+    def show_bookings_columns() -> list[str]:
+        return [
+            "otf_class.day_of_week",
+            "otf_class.date",
+            "otf_class.time",
+            "otf_class.duration",
+            "otf_class.name",
+            "status",
+            "otf_class.studio.studio_name",
+            "is_home_studio",
+        ]
+
+    def to_table(self, columns: list[str] | None = None) -> Table:
+        if not columns:
+            columns = self.show_bookings_columns()
+
+        return super().to_table(columns)

otf_api/models/responses/cancel_booking.py

@@ -0,0 +1,93 @@
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class Studio(BaseModel):
+    studio_uuid: str = Field(..., alias="studioUUId")
+    studio_name: str = Field(..., alias="studioName")
+    description: str
+    contact_email: str = Field(..., alias="contactEmail")
+    status: str
+    logo_url: str = Field(..., alias="logoUrl")
+    time_zone: str = Field(..., alias="timeZone")
+    mbo_studio_id: int = Field(..., alias="mboStudioId")
+    studio_id: int = Field(..., alias="studioId")
+    allows_cr_waitlist: bool = Field(..., alias="allowsCRWaitlist")
+    cr_waitlist_flag_last_updated: datetime = Field(..., alias="crWaitlistFlagLastUpdated")
+
+
+class Coach(BaseModel):
+    coach_uuid: str = Field(..., alias="coachUUId")
+    name: str
+    first_name: str = Field(..., alias="firstName")
+    last_name: str = Field(..., alias="lastName")
+    mbo_coach_id: int = Field(..., alias="mboCoachId")
+
+
+class Class(BaseModel):
+    class_uuid: str = Field(..., alias="classUUId")
+    name: str
+    description: str
+    start_date_time: datetime = Field(..., alias="startDateTime")
+    end_date_time: datetime = Field(..., alias="endDateTime")
+    is_available: bool = Field(..., alias="isAvailable")
+    is_cancelled: bool = Field(..., alias="isCancelled")
+    total_booked: int = Field(..., alias="totalBooked")
+    mbo_class_id: int = Field(..., alias="mboClassId")
+    mbo_studio_id: int = Field(..., alias="mboStudioId")
+    studio: Studio
+    coach: Coach
+
+
+class HomeStudio(BaseModel):
+    studio_uuid: str = Field(..., alias="studioUUId")
+    studio_name: str = Field(..., alias="studioName")
+    description: str
+    contact_email: str = Field(..., alias="contactEmail")
+    status: str
+    logo_url: str = Field(..., alias="logoUrl")
+    time_zone: str = Field(..., alias="timeZone")
+    mbo_studio_id: int = Field(..., alias="mboStudioId")
+    studio_id: int = Field(..., alias="studioId")
+    allows_cr_waitlist: bool = Field(..., alias="allowsCRWaitlist")
+    cr_waitlist_flag_last_updated: datetime = Field(..., alias="crWaitlistFlagLastUpdated")
+
+
+class Member(BaseModel):
+    member_id: int = Field(..., alias="memberId")
+    member_uuid: str = Field(..., alias="memberUUId")
+    email: str
+    phone_number: str = Field(..., alias="phoneNumber")
+    first_name: str = Field(..., alias="firstName")
+    last_name: str = Field(..., alias="lastName")
+    mbo_id: str = Field(..., alias="mboId")
+    cc_last4: str = Field(..., alias="ccLast4")
+    mbo_studio_id: int = Field(..., alias="mboStudioId")
+    home_studio: HomeStudio = Field(..., alias="homeStudio")
+
+
+class CancelBooking(BaseModel):
+    class_booking_id: int = Field(..., alias="classBookingId")
+    class_booking_uuid: str = Field(..., alias="classBookingUUId")
+    studio_id: int = Field(..., alias="studioId")
+    class_id: int = Field(..., alias="classId")
+    is_intro: bool = Field(..., alias="isIntro")
+    member_id: int = Field(..., alias="memberId")
+    mbo_member_id: str = Field(..., alias="mboMemberId")
+    mbo_class_id: int = Field(..., alias="mboClassId")
+    mbo_visit_id: int = Field(..., alias="mboVisitId")
+    mbo_waitlist_entry_id: None = Field(..., alias="mboWaitlistEntryId")
+    mbo_sync_message: str = Field(..., alias="mboSyncMessage")
+    status: str
+    booked_date: datetime = Field(..., alias="bookedDate")
+    checked_in_date: None = Field(..., alias="checkedInDate")
+    cancelled_date: datetime = Field(..., alias="cancelledDate")
+    created_by: str = Field(..., alias="createdBy")
+    created_date: datetime = Field(..., alias="createdDate")
+    updated_by: str = Field(..., alias="updatedBy")
+    updated_date: datetime = Field(..., alias="updatedDate")
+    is_deleted: bool = Field(..., alias="isDeleted")
+    otf_class: Class = Field(..., alias="class")
+    member: Member
+    continue_retry: bool = Field(..., alias="continueRetry")

otf_api/models/responses/challenge_tracker_content.py

@@ -1,15 +1,15 @@
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Year(OtfBaseModel):
+class Year(OtfItemBase):
     year: str = Field(..., alias="Year")
     is_participated: bool = Field(..., alias="IsParticipated")
     in_progress: bool = Field(..., alias="InProgress")
 
 
-class Program(OtfBaseModel):
+class Program(OtfItemBase):
     challenge_category_id: int = Field(..., alias="ChallengeCategoryId")
     challenge_sub_category_id: int = Field(..., alias="ChallengeSubCategoryId")
     challenge_name: str = Field(..., alias="ChallengeName")
@@ -17,7 +17,7 @@ class Program(OtfBaseModel):
     logo_url: str = Field(..., alias="LogoUrl")
 
 
-class Challenge(OtfBaseModel):
+class Challenge(OtfItemBase):
     challenge_category_id: int = Field(..., alias="ChallengeCategoryId")
     challenge_sub_category_id: int = Field(..., alias="ChallengeSubCategoryId")
     challenge_name: str = Field(..., alias="ChallengeName")
@@ -25,14 +25,14 @@ class Challenge(OtfBaseModel):
     logo_url: str = Field(..., alias="LogoUrl")
 
 
-class Benchmark(OtfBaseModel):
+class Benchmark(OtfItemBase):
     equipment_id: int = Field(..., alias="EquipmentId")
     equipment_name: str = Field(..., alias="EquipmentName")
     years: list[Year] = Field(..., alias="Years")
     logo_url: str = Field(..., alias="LogoUrl")
 
 
-class ChallengeTrackerContent(OtfBaseModel):
+class ChallengeTrackerContent(OtfItemBase):
     programs: list[Program] = Field(..., alias="Programs")
     challenges: list[Challenge] = Field(..., alias="Challenges")
     benchmarks: list[Benchmark] = Field(..., alias="Benchmarks")

otf_api/models/responses/challenge_tracker_detail.py

@@ -3,10 +3,10 @@ from typing import Any
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class MetricEntry(OtfBaseModel):
+class MetricEntry(OtfItemBase):
     title: str = Field(..., alias="Title")
     equipment_id: int = Field(..., alias="EquipmentId")
     entry_type: str = Field(..., alias="EntryType")
@@ -15,7 +15,7 @@ class MetricEntry(OtfBaseModel):
     max_value: str = Field(..., alias="MaxValue")
 
 
-class BenchmarkHistory(OtfBaseModel):
+class BenchmarkHistory(OtfItemBase):
     studio_name: str = Field(..., alias="StudioName")
     equipment_id: int = Field(..., alias="EquipmentId")
     result: float | str = Field(..., alias="Result")
@@ -36,7 +36,7 @@ class BenchmarkHistory(OtfBaseModel):
     )  # not sure what this will be, never seen it before
 
 
-class ChallengeHistory(OtfBaseModel):
+class ChallengeHistory(OtfItemBase):
     challenge_objective: str = Field(..., alias="ChallengeObjective")
     challenge_id: int = Field(..., alias="ChallengeId")
     studio_id: int = Field(..., alias="StudioId")
@@ -48,7 +48,7 @@ class ChallengeHistory(OtfBaseModel):
     benchmark_histories: list[BenchmarkHistory] = Field(..., alias="BenchmarkHistories")
 
 
-class ChallengeTrackerDetail(OtfBaseModel):
+class ChallengeTrackerDetail(OtfItemBase):
     challenge_category_id: int = Field(..., alias="ChallengeCategoryId")
     challenge_sub_category_id: None = Field(..., alias="ChallengeSubCategoryId")
     equipment_id: int = Field(..., alias="EquipmentId")
@@ -64,5 +64,5 @@ class ChallengeTrackerDetail(OtfBaseModel):
     challenge_histories: list[ChallengeHistory] = Field(..., alias="ChallengeHistories")
 
 
-class ChallengeTrackerDetailList(OtfBaseModel):
+class ChallengeTrackerDetailList(OtfItemBase):
     details: list[ChallengeTrackerDetail]