otf-api 0.2.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

otf_api/models/responses/classes.py

@@ -1,9 +1,76 @@
 from datetime import datetime
+from enum import Enum
+from typing import ClassVar
 
-from otf_api.models.base import OtfBaseModel
+from humanize import precisedelta
+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 OtfItemBase, OtfListBase
 
-class Address(OtfBaseModel):
+
+class DoW(str, Enum):
+    monday = "monday"
+    tuesday = "tuesday"
+    wednesday = "wednesday"
+    thursday = "thursday"
+    friday = "friday"
+    saturday = "saturday"
+    sunday = "sunday"
+
+    @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 ClassType(str, Enum):
+    ORANGE_60_MIN_2G = "Orange 60 Min 2G"
+    TREAD_50 = "Tread 50"
+    STRENGTH_50 = "Strength 50"
+    ORANGE_3G = "Orange 3G"
+    ORANGE_60_TORNADO = "Orange 60 - Tornado"
+    ORANGE_TORNADO = "Orange Tornado"
+    ORANGE_90_MIN_3G = "Orange 90 Min 3G"
+    VIP_CLASS = "VIP Class"
+    OTHER = "Other"
+
+    @classmethod
+    def all_statuses(cls) -> list[str]:
+        return list(cls.__members__.values())
+
+    @classmethod
+    def get_from_key_insensitive(cls, key: str) -> "ClassType":
+        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 ClassType: {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()]
+
+
+class ClassTypeCli(str, Enum):
+    """Flipped enum so that the CLI does not have values with spaces"""
+
+    ORANGE_60_MIN_2G = "Orange_60_Min_2G"
+    TREAD_50 = "Tread_50"
+    STRENGTH_50 = "Strength_50"
+    ORANGE_3G = "Orange_3G"
+    ORANGE_60_TORNADO = "Orange_60_Tornado"
+    ORANGE_TORNADO = "Orange_Tornado"
+    ORANGE_90_MIN_3G = "Orange_90_Min_3G"
+    VIP_CLASS = "VIP_Class"
+    OTHER = "Other"
+
+
+class Address(OtfItemBase):
     line1: str
     city: str
     state: str
@@ -11,7 +78,7 @@ class Address(OtfBaseModel):
     postal_code: str
 
 
-class Studio(OtfBaseModel):
+class Studio(OtfItemBase):
     id: str
     name: str
     mbo_studio_id: str
@@ -23,15 +90,57 @@ class Studio(OtfBaseModel):
     longitude: float
 
 
-class Coach(OtfBaseModel):
+class Coach(OtfItemBase):
     mbo_staff_id: str
     first_name: str
     image_url: str | None = None
 
 
-class OtfClass(OtfBaseModel):
+class OtfClassTimeMixin:
+    starts_at_local: datetime
+    ends_at_local: datetime
+    name: str
+
+    @property
+    def day_of_week(self) -> str:
+        return self.starts_at_local.strftime("%A")
+
+    @property
+    def date(self) -> str:
+        return self.starts_at_local.strftime("%Y-%m-%d")
+
+    @property
+    def time(self) -> str:
+        """Returns time in 12 hour clock format, with no leading 0"""
+        val = self.starts_at_local.strftime("%I:%M %p")
+        if val[0] == "0":
+            val = " " + val[1:]
+
+        return val
+
+    @property
+    def duration(self) -> str:
+        duration = self.ends_at_local - self.starts_at_local
+        human_val: str = precisedelta(duration, minimum_unit="minutes")
+        if human_val == "1 hour and 30 minutes":
+            return "90 minutes"
+        return human_val
+
+    @property
+    def class_type(self) -> ClassType:
+        for class_type in ClassType:
+            if class_type.value in self.name:
+                return class_type
+
+        return ClassType.OTHER
+
+
+class OtfClass(OtfItemBase, OtfClassTimeMixin):
     id: str
-    ot_base_class_uuid: str
+    ot_class_uuid: str = Field(
+        alias="ot_base_class_uuid",
+        description="The OTF class UUID, this is what shows in a booking response and how you can book a class.",
+    )
     starts_at: datetime
     starts_at_local: datetime
     ends_at: datetime
@@ -51,7 +160,96 @@ class OtfClass(OtfBaseModel):
     mbo_class_description_id: str
     created_at: datetime
     updated_at: datetime
+    is_home_studio: bool | None = Field(None, description="Custom helper field to determine if at home studio")
+    is_booked: bool | None = Field(None, description="Custom helper field to determine if class is already booked")
+
+    @property
+    def has_availability(self) -> bool:
+        return not self.full
+
+    @property
+    def id_val(self) -> str:
+        return self.ot_class_uuid
+
+    @property
+    def day_of_week_enum(self) -> DoW:
+        dow = self.starts_at_local.strftime("%A")
+        return DoW.get_case_insensitive(dow)
+
+    @property
+    def sidebar_data(self) -> Table:
+        data = {
+            "class_date": self.date,
+            "class_time": self.time.strip(),
+            "class_name": self.name,
+            "class_id": self.id_val,
+            "available": self.has_availability,
+            "waitlist_available": self.waitlist_available,
+            "studio_address": self.studio.address.line1,
+            "coach_name": self.coach.first_name,
+            "waitlist_size": self.waitlist_size,
+            "max_capacity": self.max_capacity,
+        }
+
+        if not self.full:
+            del data["waitlist_available"]
+            del data["waitlist_size"]
+
+        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))
 
-class OtfClassList(OtfBaseModel):
+        return table
+
+    def get_style(self, is_selected: bool = False) -> Style:
+        style = super().get_style(is_selected)
+        if self.is_booked:
+            style = Style(color="grey58")
+        return style
+
+    @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 OtfClassList(OtfListBase):
+    collection_field: ClassVar[str] = "classes"
     classes: list[OtfClass]
+
+    @staticmethod
+    def book_class_columns() -> list[str]:
+        return [
+            "day_of_week",
+            "date",
+            "time",
+            "duration",
+            "name",
+            "studio.name",
+            "is_home_studio",
+            "is_booked",
+        ]
+
+    def to_table(self, columns: list[str] | None = None) -> Table:
+        if not columns:
+            columns = self.book_class_columns()
+
+        return super().to_table(columns)

otf_api/models/responses/enums.py

@@ -1,19 +1,6 @@
 from enum import Enum
 
 
-class StudioStatus(str, Enum):
-    OTHER = "OTHER"
-    ACTIVE = "Active"
-    INACTIVE = "Inactive"
-    COMING_SOON = "Coming Soon"
-    TEMP_CLOSED = "Temporarily Closed"
-    PERM_CLOSED = "Permanently Closed"
-
-    @classmethod
-    def all_statuses(cls) -> list[str]:
-        return list(cls.__members__.values())
-
-
 class EquipmentType(int, Enum):
     Treadmill = 2
     Strider = 3
@@ -36,23 +23,6 @@ class ChallengeType(int, Enum):
     BackAtIt = 84
 
 
-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 all_statuses(cls) -> list[str]:
-        return list(cls.__members__.values())
-
-
 class HistoryBookingStatus(str, Enum):
     Attended = "Attended"
     Cancelled = "Cancelled"
@@ -80,8 +50,3 @@ class HistoryClassStatus(str, Enum):
     @classmethod
     def all_statuses(cls) -> list[str]:
         return list(cls.__members__.values())
-
-
-ALL_CLASS_STATUS = BookingStatus.all_statuses()
-ALL_HISTORY_CLASS_STATUS = HistoryClassStatus.all_statuses()
-ALL_STUDIO_STATUS = StudioStatus.all_statuses()

otf_api/models/responses/favorite_studios.py

@@ -2,10 +2,10 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Location(OtfBaseModel):
+class Location(OtfItemBase):
     location_id: int = Field(..., alias="locationId")
     location_uuid: str = Field(..., alias="locationUUId")
     studio_id: int = Field(..., alias="studioId")
@@ -21,7 +21,7 @@ class Location(OtfBaseModel):
     postal_code: str = Field(..., alias="postalCode")
 
 
-class StudioLocation(OtfBaseModel):
+class StudioLocation(OtfItemBase):
     bill_to_address: str = Field(..., alias="billToAddress")
     bill_to_address2: str = Field(..., alias="billToAddress2")
     bill_to_city: str = Field(..., alias="billToCity")
@@ -51,7 +51,7 @@ class StudioLocation(OtfBaseModel):
     longitude: str
 
 
-class FavoriteStudio(OtfBaseModel):
+class FavoriteStudio(OtfItemBase):
     studio_id: int = Field(..., alias="studioId")
     studio_uuid: str = Field(..., alias="studioUUId")
     mbo_studio_id: int = Field(..., alias="mboStudioId")
@@ -94,7 +94,7 @@ class FavoriteStudio(OtfBaseModel):
     studio_location: StudioLocation = Field(..., alias="studioLocation")
 
 
-class FavoriteStudioList(OtfBaseModel):
+class FavoriteStudioList(OtfItemBase):
     studios: list[FavoriteStudio]
 
     @property

otf_api/models/responses/latest_agreement.py

@@ -2,10 +2,10 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class LatestAgreement(OtfBaseModel):
+class LatestAgreement(OtfItemBase):
     file_url: str = Field(..., alias="fileUrl")
     agreement_id: int = Field(..., alias="agreementId")
     agreement_uuid: str = Field(..., alias="agreementUUId")

otf_api/models/responses/lifetime_stats.py

@@ -0,0 +1,92 @@
+from enum import Enum
+
+from pydantic import BaseModel, Field
+
+
+class StatsTime(str, Enum):
+    LastYear = "lastYear"
+    ThisYear = "thisYear"
+    LastMonth = "lastMonth"
+    ThisMonth = "thisMonth"
+    LastWeek = "lastWeek"
+    ThisWeek = "thisWeek"
+    AllTime = "allTime"
+
+
+class StatsType(str, Enum):
+    Home = "outStudio"
+    Studio = "inStudio"
+    All = "allStats"
+
+
+class OutStudioMixin(BaseModel):
+    walking_distance: float = Field(..., alias="walkingDistance")
+    running_distance: float = Field(..., alias="runningDistance")
+    cycling_distance: float = Field(..., alias="cyclingDistance")
+
+
+class InStudioMixin(BaseModel):
+    treadmill_distance: float = Field(..., alias="treadmillDistance")
+    treadmill_elevation_gained: float = Field(..., alias="treadmillElevationGained")
+    rower_distance: float = Field(..., alias="rowerDistance")
+    rower_watt: float = Field(..., alias="rowerWatt")
+
+
+class BaseStatsData(BaseModel):
+    calories: float
+    splat_point: float = Field(..., alias="splatPoint")
+    total_black_zone: float = Field(..., alias="totalBlackZone")
+    total_blue_zone: float = Field(..., alias="totalBlueZone")
+    total_green_zone: float = Field(..., alias="totalGreenZone")
+    total_orange_zone: float = Field(..., alias="totalOrangeZone")
+    total_red_zone: float = Field(..., alias="totalRedZone")
+    workout_duration: float = Field(..., alias="workoutDuration")
+    step_count: float = Field(..., alias="stepCount")
+
+
+class InStudioStatsData(InStudioMixin, BaseStatsData):
+    pass
+
+
+class OutStudioStatsData(OutStudioMixin, BaseStatsData):
+    pass
+
+
+class AllStatsData(OutStudioMixin, InStudioMixin, BaseStatsData):
+    pass
+
+
+class OutStudioTimeStats(BaseModel):
+    last_year: OutStudioStatsData = Field(..., alias="lastYear")
+    this_year: OutStudioStatsData = Field(..., alias="thisYear")
+    last_month: OutStudioStatsData = Field(..., alias="lastMonth")
+    this_month: OutStudioStatsData = Field(..., alias="thisMonth")
+    last_week: OutStudioStatsData = Field(..., alias="lastWeek")
+    this_week: OutStudioStatsData = Field(..., alias="thisWeek")
+    all_time: OutStudioStatsData = Field(..., alias="allTime")
+
+
+class InStudioTimeStats(BaseModel):
+    last_year: InStudioStatsData = Field(..., alias="lastYear")
+    this_year: InStudioStatsData = Field(..., alias="thisYear")
+    last_month: InStudioStatsData = Field(..., alias="lastMonth")
+    this_month: InStudioStatsData = Field(..., alias="thisMonth")
+    last_week: InStudioStatsData = Field(..., alias="lastWeek")
+    this_week: InStudioStatsData = Field(..., alias="thisWeek")
+    all_time: InStudioStatsData = Field(..., alias="allTime")
+
+
+class AllStatsTimeStats(BaseModel):
+    last_year: AllStatsData = Field(..., alias="lastYear")
+    this_year: AllStatsData = Field(..., alias="thisYear")
+    last_month: AllStatsData = Field(..., alias="lastMonth")
+    this_month: AllStatsData = Field(..., alias="thisMonth")
+    last_week: AllStatsData = Field(..., alias="lastWeek")
+    this_week: AllStatsData = Field(..., alias="thisWeek")
+    all_time: AllStatsData = Field(..., alias="allTime")
+
+
+class StatsResponse(BaseModel):
+    all_stats: AllStatsTimeStats = Field(..., alias="allStats")
+    in_studio: InStudioTimeStats = Field(..., alias="inStudio")
+    out_studio: OutStudioTimeStats = Field(..., alias="outStudio")

otf_api/models/responses/member_detail.py

@@ -3,12 +3,11 @@ from typing import Any
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Address(OtfBaseModel):
-    member_address_uuid: str = Field(..., alias="memberAddressUUId")
-    memberaddress_uuid: str = Field(..., alias="memberaddressUUId")
+class Address(OtfItemBase):
+    member_address_uuid: str | None = Field(None, alias="memberAddressUUId")
     type: str
     address1: str
     address2: str | None = None
@@ -17,28 +16,34 @@ class Address(OtfBaseModel):
     postal_code: str = Field(..., alias="postalCode")
     country: str
 
+    def __init__(self, **data):
+        if "memberaddressUUId" in data:
+            data["memberAddressUUId"] = data.pop("memberaddressUUId")
 
-class MemberCreditCard(OtfBaseModel):
+        super().__init__(**data)
+
+
+class MemberCreditCard(OtfItemBase):
     name_on_card: str = Field(..., alias="nameOnCard")
     cc_type: str = Field(..., alias="ccType")
     cc_last4: str = Field(..., alias="ccLast4")
 
 
-class PhysicalCountryDetails(OtfBaseModel):
+class PhysicalCountryDetails(OtfItemBase):
     country_code: str = Field(..., alias="countryCode")
     description: str
 
 
-class StudioLocation(OtfBaseModel):
+class StudioLocation(OtfItemBase):
     physical_country_id: int = Field(..., alias="physicalCountryId")
     physical_country_details: PhysicalCountryDetails = Field(..., alias="physicalCountryDetails")
 
 
-class StudioPartner(OtfBaseModel):
+class StudioPartner(OtfItemBase):
     studio_acs_id: str = Field(..., alias="studioAcsId")
 
 
-class HomeStudio(OtfBaseModel):
+class HomeStudio(OtfItemBase):
     studio_id: int = Field(..., alias="studioId")
     studio_uuid: str = Field(..., alias="studioUUId")
     studio_name: str = Field(..., alias="studioName")
@@ -51,7 +56,7 @@ class HomeStudio(OtfBaseModel):
     studio_partner: StudioPartner = Field(..., alias="studioPartner")
 
 
-class MemberProfile(OtfBaseModel):
+class MemberProfile(OtfItemBase):
     member_profile_uuid: str = Field(..., alias="memberProfileUUId")
     unit_of_measure: str = Field(..., alias="unitOfMeasure")
     max_hr_type: str = Field(..., alias="maxHrType")
@@ -61,7 +66,7 @@ class MemberProfile(OtfBaseModel):
     member_optin_flow_type_id: int = Field(..., alias="memberOptinFlowTypeId")
 
 
-class MemberClassSummary(OtfBaseModel):
+class MemberClassSummary(OtfItemBase):
     total_classes_booked: int = Field(..., alias="totalClassesBooked")
     total_classes_attended: int = Field(..., alias="totalClassesAttended")
     total_intro: int = Field(..., alias="totalIntro")
@@ -75,7 +80,7 @@ class MemberClassSummary(OtfBaseModel):
     last_class_studio_visited: int = Field(..., alias="lastClassStudioVisited")
 
 
-class MemberDetail(OtfBaseModel):
+class MemberDetail(OtfItemBase):
     member_id: int = Field(..., alias="memberId")
     member_uuid: str = Field(..., alias="memberUUId")
     cognito_id: str = Field(..., alias="cognitoId")

otf_api/models/responses/member_membership.py

@@ -2,10 +2,10 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class MemberMembership(OtfBaseModel):
+class MemberMembership(OtfItemBase):
     member_membership_id: int = Field(..., alias="memberMembershipId")
     member_membership_uuid: str = Field(..., alias="memberMembershipUUId")
     membership_id: int = Field(..., alias="membershipId")

otf_api/models/responses/member_purchases.py

@@ -2,10 +2,10 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class Location(OtfBaseModel):
+class Location(OtfItemBase):
     phone: str
     latitude: str
     longitude: str
@@ -16,16 +16,16 @@ class Location(OtfBaseModel):
     postal_code: str = Field(..., alias="postalCode")
 
 
-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 Country(OtfBaseModel):
+class Country(OtfItemBase):
     country_id: int = Field(..., alias="countryId")
     country_code: str = Field(..., alias="countryCode")
     description: str
@@ -33,7 +33,7 @@ class Country(OtfBaseModel):
     default_currency: DefaultCurrency = Field(..., alias="defaultCurrency")
 
 
-class StudioLocation(OtfBaseModel):
+class StudioLocation(OtfItemBase):
     studio_location_id: int = Field(..., alias="studioLocationId")
     bill_to_address: str = Field(..., alias="billToAddress")
     bill_to_address2: str = Field(..., alias="billToAddress2")
@@ -65,7 +65,7 @@ class StudioLocation(OtfBaseModel):
     country: Country
 
 
-class Studio(OtfBaseModel):
+class Studio(OtfItemBase):
     studio_id: int = Field(..., alias="studioId")
     studio_uuid: str = Field(..., alias="studioUUId")
     mbo_studio_id: int = Field(..., alias="mboStudioId")
@@ -109,7 +109,7 @@ class Studio(OtfBaseModel):
     studio_location: StudioLocation = Field(..., alias="studioLocation")
 
 
-class MemberPurchase(OtfBaseModel):
+class MemberPurchase(OtfItemBase):
     member_purchase_id: int = Field(..., alias="memberPurchaseId")
     member_purchase_uuid: str = Field(..., alias="memberPurchaseUUId")
     studio_id: int = Field(..., alias="studioId")
@@ -131,5 +131,5 @@ class MemberPurchase(OtfBaseModel):
     studio: Studio
 
 
-class MemberPurchaseList(OtfBaseModel):
+class MemberPurchaseList(OtfItemBase):
     data: list[MemberPurchase]

otf_api/models/responses/out_of_studio_workout_history.py

@@ -2,16 +2,16 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfBaseModel
+from otf_api.models.base import OtfItemBase
 
 
-class WorkoutType(OtfBaseModel):
+class WorkoutType(OtfItemBase):
     id: int
     display_name: str = Field(..., alias="displayName")
     icon: str
 
 
-class OutOfStudioWorkoutHistory(OtfBaseModel):
+class OutOfStudioWorkoutHistory(OtfItemBase):
     workout_date: datetime = Field(..., alias="workoutDate")
     start_time: datetime = Field(..., alias="startTime")
     end_time: datetime = Field(..., alias="endTime")
@@ -37,5 +37,5 @@ class OutOfStudioWorkoutHistory(OtfBaseModel):
     max_heartrate: int = Field(..., alias="maxHeartrate")
 
 
-class OutOfStudioWorkoutHistoryList(OtfBaseModel):
+class OutOfStudioWorkoutHistoryList(OtfItemBase):
     data: list[OutOfStudioWorkoutHistory]

otf_api/models/responses/performance_summary_detail.py

@@ -74,4 +74,4 @@ class PerformanceSummaryDetail(BaseModel):
     id: str
     details: Details
     ratable: bool
-    class_: Class = Field(..., alias="class")
+    otf_class: Class = Field(..., alias="class")