otf-api 0.2.0__py3-none-any.whl

otf_api/models/__init__.py

@@ -0,0 +1,63 @@
+from .auth import User
+from .responses import (
+    ALL_CLASS_STATUS,
+    ALL_HISTORY_CLASS_STATUS,
+    ALL_STUDIO_STATUS,
+    BookingList,
+    BookingStatus,
+    ChallengeTrackerContent,
+    ChallengeTrackerDetailList,
+    ChallengeType,
+    EquipmentType,
+    FavoriteStudioList,
+    HistoryClassStatus,
+    LatestAgreement,
+    MemberDetail,
+    MemberMembership,
+    MemberPurchaseList,
+    OtfClassList,
+    OutOfStudioWorkoutHistoryList,
+    PerformanceSummaryDetail,
+    PerformanceSummaryList,
+    StudioDetail,
+    StudioDetailList,
+    StudioServiceList,
+    StudioStatus,
+    Telemetry,
+    TelemetryHrHistory,
+    TelemetryMaxHr,
+    TotalClasses,
+    WorkoutList,
+)
+
+__all__ = [
+    "User",
+    "ChallengeType",
+    "BookingStatus",
+    "EquipmentType",
+    "HistoryClassStatus",
+    "StudioStatus",
+    "BookingList",
+    "ChallengeTrackerContent",
+    "ChallengeTrackerDetailList",
+    "LatestAgreement",
+    "MemberDetail",
+    "MemberMembership",
+    "MemberPurchaseList",
+    "OutOfStudioWorkoutHistoryList",
+    "StudioServiceList",
+    "TotalClasses",
+    "WorkoutList",
+    "FavoriteStudioList",
+    "OtfClassList",
+    "TelemetryHrHistory",
+    "Telemetry",
+    "TelemetryMaxHr",
+    "StudioDetail",
+    "StudioDetailList",
+    "ALL_CLASS_STATUS",
+    "ALL_HISTORY_CLASS_STATUS",
+    "ALL_STUDIO_STATUS",
+    "PerformanceSummaryDetail",
+    "PerformanceSummaryList",
+]

otf_api/models/auth.py

@@ -0,0 +1,141 @@
+import json
+from pathlib import Path
+from typing import ClassVar
+
+from pycognito import Cognito, TokenVerificationException
+from pydantic import Field
+
+from otf_api.models.base import OtfBaseModel
+
+CLIENT_ID = "65knvqta6p37efc2l3eh26pl5o"  # from otlive
+USER_POOL_ID = "us-east-1_dYDxUeyL1"
+
+
+class IdClaimsData(OtfBaseModel):
+    sub: str
+    email_verified: bool
+    iss: str
+    cognito_username: str = Field(alias="cognito:username")
+    given_name: str
+    locale: str
+    home_studio_id: str = Field(alias="custom:home_studio_id")
+    aud: str
+    event_id: str
+    token_use: str
+    auth_time: int
+    exp: int
+    is_migration: str = Field(alias="custom:isMigration")
+    iat: int
+    family_name: str
+    email: str
+
+    @property
+    def member_uuid(self) -> str:
+        return self.cognito_username
+
+    @property
+    def full_name(self) -> str:
+        return f"{self.given_name} {self.family_name}"
+
+
+class AccessClaimsData(OtfBaseModel):
+    sub: str
+    device_key: str
+    iss: str
+    client_id: str
+    event_id: str
+    token_use: str
+    scope: str
+    auth_time: int
+    exp: int
+    iat: int
+    jti: str
+    username: str
+
+    @property
+    def member_uuid(self) -> str:
+        return self.username
+
+
+class User:
+    token_path: ClassVar[Path] = Path("~/.otf/.tokens").expanduser()
+    cognito: Cognito
+
+    def __init__(self, cognito: Cognito):
+        self.cognito = cognito
+
+    @property
+    def member_id(self) -> str:
+        return self.id_claims_data.cognito_username
+
+    @property
+    def member_uuid(self) -> str:
+        return self.access_claims_data.sub
+
+    @property
+    def access_claims_data(self) -> AccessClaimsData:
+        return AccessClaimsData(**self.cognito.access_claims)
+
+    @property
+    def id_claims_data(self) -> IdClaimsData:
+        return IdClaimsData(**self.cognito.id_claims)
+
+    def save_to_disk(self) -> None:
+        self.token_path.parent.mkdir(parents=True, exist_ok=True)
+        data = {
+            "username": self.cognito.username,
+            "id_token": self.cognito.id_token,
+            "access_token": self.cognito.access_token,
+            "refresh_token": self.cognito.refresh_token,
+        }
+        self.token_path.write_text(json.dumps(data))
+
+    @classmethod
+    def load_from_disk(cls, username: str | None = None, password: str | None = None) -> "User":
+        """Load a User instance from disk. If the token is invalid, reauthenticate with the provided credentials.
+
+        Args:
+            username (str | None): The username to reauthenticate with.
+            password (str | None): The password to reauthenticate with.
+
+        Returns:
+            User: The loaded user.
+
+        Raises:
+            ValueError: If the token is invalid and no username and password are provided.
+        """
+        attr_dict = json.loads(cls.token_path.read_text())
+
+        cognito_user = Cognito(USER_POOL_ID, CLIENT_ID, **attr_dict)
+        try:
+            cognito_user.verify_tokens()
+            return cls(cognito=cognito_user)
+        except TokenVerificationException:
+            if username and password:
+                user = cls.login(username, password)
+                return user
+            raise
+
+    @classmethod
+    def login(cls, username: str, password: str) -> "User":
+        """Login and return a User instance. After a successful login, the user is saved to disk.
+
+        Args:
+            username (str): The username to login with.
+            password (str): The password to login with.
+
+        Returns:
+            User: The logged in user.
+        """
+        cognito_user = Cognito(USER_POOL_ID, CLIENT_ID, username=username)
+        cognito_user.authenticate(password)
+        cognito_user.check_token()
+        user = cls(cognito=cognito_user)
+        user.save_to_disk()
+        return user
+
+    def refresh_token(self) -> "User":
+        """Refresh the user's access token."""
+        self.cognito.check_token()
+        self.save_to_disk()
+        return self

otf_api/models/base.py

@@ -0,0 +1,7 @@
+from typing import ClassVar
+
+from pydantic import BaseModel, ConfigDict
+
+
+class OtfBaseModel(BaseModel):
+    model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="forbid")

otf_api/models/responses/__init__.py

@@ -0,0 +1,60 @@
+from .bookings import BookingList
+from .challenge_tracker_content import ChallengeTrackerContent
+from .challenge_tracker_detail import ChallengeTrackerDetailList
+from .classes import OtfClassList
+from .enums import (
+    ALL_CLASS_STATUS,
+    ALL_HISTORY_CLASS_STATUS,
+    ALL_STUDIO_STATUS,
+    BookingStatus,
+    ChallengeType,
+    EquipmentType,
+    HistoryClassStatus,
+    StudioStatus,
+)
+from .favorite_studios import FavoriteStudioList
+from .latest_agreement import LatestAgreement
+from .member_detail import MemberDetail
+from .member_membership import MemberMembership
+from .member_purchases import MemberPurchaseList
+from .out_of_studio_workout_history import OutOfStudioWorkoutHistoryList
+from .performance_summary_detail import PerformanceSummaryDetail
+from .performance_summary_list import PerformanceSummaryList
+from .studio_detail import StudioDetail, StudioDetailList
+from .studio_services import StudioServiceList
+from .telemetry import Telemetry
+from .telemetry_hr_history import TelemetryHrHistory
+from .telemetry_max_hr import TelemetryMaxHr
+from .total_classes import TotalClasses
+from .workouts import WorkoutList
+
+__all__ = [
+    "BookingList",
+    "ChallengeTrackerContent",
+    "ChallengeTrackerDetailList",
+    "LatestAgreement",
+    "MemberDetail",
+    "MemberMembership",
+    "MemberPurchaseList",
+    "OutOfStudioWorkoutHistoryList",
+    "StudioServiceList",
+    "TotalClasses",
+    "WorkoutList",
+    "ChallengeType",
+    "BookingStatus",
+    "EquipmentType",
+    "HistoryClassStatus",
+    "StudioStatus",
+    "FavoriteStudioList",
+    "OtfClassList",
+    "TelemetryHrHistory",
+    "Telemetry",
+    "TelemetryMaxHr",
+    "StudioDetail",
+    "StudioDetailList",
+    "ALL_CLASS_STATUS",
+    "ALL_HISTORY_CLASS_STATUS",
+    "ALL_STUDIO_STATUS",
+    "PerformanceSummaryDetail",
+    "PerformanceSummaryList",
+]

otf_api/models/responses/bookings.py

@@ -0,0 +1,130 @@
+from datetime import datetime
+
+from pydantic import Field
+
+from otf_api.models.base import OtfBaseModel
+
+from .enums import BookingStatus, StudioStatus
+
+
+class Location(OtfBaseModel):
+    address_one: str = Field(alias="address1")
+    address_two: str | None = Field(alias="address2")
+    city: str
+    country: str | None = None
+    distance: float | None = None
+    latitude: float = Field(alias="latitude")
+    location_name: str | None = Field(None, alias="locationName")
+    longitude: float = Field(alias="longitude")
+    phone_number: str = Field(alias="phone")
+    postal_code: str | None = Field(None, alias="postalCode")
+    state: str | None = None
+
+
+class Coach(OtfBaseModel):
+    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")
+
+
+class Currency(OtfBaseModel):
+    currency_alphabetic_code: str = Field(alias="currencyAlphabeticCode")
+
+
+class DefaultCurrency(OtfBaseModel):
+    currency_id: int = Field(alias="currencyId")
+    currency: Currency
+
+
+class StudioLocationCountry(OtfBaseModel):
+    country_currency_code: str = Field(alias="countryCurrencyCode")
+    default_currency: DefaultCurrency = Field(alias="defaultCurrency")
+
+
+class StudioLocation(OtfBaseModel):
+    latitude: float = Field(alias="latitude")
+    longitude: float = Field(alias="longitude")
+    phone_number: str = Field(alias="phoneNumber")
+    physical_city: str = Field(alias="physicalCity")
+    physical_address: str = Field(alias="physicalAddress")
+    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_country: str = Field(alias="physicalCountry")
+    country: StudioLocationCountry = Field(alias="country")
+
+
+class Studio(OtfBaseModel):
+    studio_uuid: str = Field(alias="studioUUId")
+    studio_name: str = Field(alias="studioName")
+    description: str
+    contact_email: str = Field(alias="contactEmail")
+    status: StudioStatus
+    logo_url: str | None = 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 | None = Field(None, alias="allowsCRWaitlist")
+    cr_waitlist_flag_last_updated: datetime = Field(alias="crWaitlistFlagLastUpdated")
+    studio_location: StudioLocation = Field(alias="studioLocation")
+
+
+class OtfClass(OtfBaseModel):
+    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")
+    program_name: str = Field(alias="programName")
+    coach_id: int = Field(alias="coachId")
+    studio: Studio
+    coach: Coach
+    location: Location
+    virtual_class: bool | None = Field(None, alias="virtualClass")
+
+
+class Member(OtfBaseModel):
+    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")
+
+
+class Booking(OtfBaseModel):
+    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")
+    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_date: datetime = Field(alias="createdDate")
+    updated_by: str = Field(alias="updatedBy")
+    updated_date: datetime = Field(alias="updatedDate")
+    is_deleted: bool = Field(alias="isDeleted")
+    member: Member
+    waitlist_position: int | None = Field(None, alias="waitlistPosition")
+    class_: OtfClass | None = Field(None, alias="class")
+
+
+class BookingList(OtfBaseModel):
+    bookings: list[Booking]

otf_api/models/responses/challenge_tracker_content.py

@@ -0,0 +1,38 @@
+from pydantic import Field
+
+from otf_api.models.base import OtfBaseModel
+
+
+class Year(OtfBaseModel):
+    year: str = Field(..., alias="Year")
+    is_participated: bool = Field(..., alias="IsParticipated")
+    in_progress: bool = Field(..., alias="InProgress")
+
+
+class Program(OtfBaseModel):
+    challenge_category_id: int = Field(..., alias="ChallengeCategoryId")
+    challenge_sub_category_id: int = Field(..., alias="ChallengeSubCategoryId")
+    challenge_name: str = Field(..., alias="ChallengeName")
+    years: list[Year] = Field(..., alias="Years")
+    logo_url: str = Field(..., alias="LogoUrl")
+
+
+class Challenge(OtfBaseModel):
+    challenge_category_id: int = Field(..., alias="ChallengeCategoryId")
+    challenge_sub_category_id: int = Field(..., alias="ChallengeSubCategoryId")
+    challenge_name: str = Field(..., alias="ChallengeName")
+    years: list[Year] = Field(..., alias="Years")
+    logo_url: str = Field(..., alias="LogoUrl")
+
+
+class Benchmark(OtfBaseModel):
+    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):
+    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

@@ -0,0 +1,68 @@
+from datetime import datetime
+from typing import Any
+
+from pydantic import Field
+
+from otf_api.models.base import OtfBaseModel
+
+
+class MetricEntry(OtfBaseModel):
+    title: str = Field(..., alias="Title")
+    equipment_id: int = Field(..., alias="EquipmentId")
+    entry_type: str = Field(..., alias="EntryType")
+    metric_key: str = Field(..., alias="MetricKey")
+    min_value: str = Field(..., alias="MinValue")
+    max_value: str = Field(..., alias="MaxValue")
+
+
+class BenchmarkHistory(OtfBaseModel):
+    studio_name: str = Field(..., alias="StudioName")
+    equipment_id: int = Field(..., alias="EquipmentId")
+    result: float | str = Field(..., alias="Result")
+    date_created: datetime = Field(..., alias="DateCreated")
+    date_updated: datetime = Field(..., alias="DateUpdated")
+    class_time: datetime = Field(..., alias="ClassTime")
+    challenge_sub_category_id: None = Field(..., alias="ChallengeSubCategoryId")
+    class_id: int = Field(..., alias="ClassId")
+    substitute_id: int | None = Field(..., alias="SubstituteId")
+    weight_lbs: int = Field(..., alias="WeightLBS")
+    class_name: str = Field(..., alias="ClassName")
+    coach_name: str = Field(..., alias="CoachName")
+    coach_image_url: str = Field(..., alias="CoachImageUrl")
+    workout_type_id: None = Field(..., alias="WorkoutTypeId")
+    workout_id: None = Field(..., alias="WorkoutId")
+    linked_challenges: list[Any] = Field(
+        ..., alias="LinkedChallenges"
+    )  # not sure what this will be, never seen it before
+
+
+class ChallengeHistory(OtfBaseModel):
+    challenge_objective: str = Field(..., alias="ChallengeObjective")
+    challenge_id: int = Field(..., alias="ChallengeId")
+    studio_id: int = Field(..., alias="StudioId")
+    studio_name: str = Field(..., alias="StudioName")
+    start_date: datetime = Field(..., alias="StartDate")
+    end_date: datetime = Field(..., alias="EndDate")
+    total_result: float | str = Field(..., alias="TotalResult")
+    is_finished: bool = Field(..., alias="IsFinished")
+    benchmark_histories: list[BenchmarkHistory] = Field(..., alias="BenchmarkHistories")
+
+
+class ChallengeTrackerDetail(OtfBaseModel):
+    challenge_category_id: int = Field(..., alias="ChallengeCategoryId")
+    challenge_sub_category_id: None = Field(..., alias="ChallengeSubCategoryId")
+    equipment_id: int = Field(..., alias="EquipmentId")
+    equipment_name: str = Field(..., alias="EquipmentName")
+    metric_entry: MetricEntry = Field(..., alias="MetricEntry")
+    challenge_name: str = Field(..., alias="ChallengeName")
+    logo_url: str = Field(..., alias="LogoUrl")
+    best_record: float | str = Field(..., alias="BestRecord")
+    last_record: float | str = Field(..., alias="LastRecord")
+    previous_record: float | str = Field(..., alias="PreviousRecord")
+    unit: str | None = Field(..., alias="Unit")
+    goals: None = Field(..., alias="Goals")
+    challenge_histories: list[ChallengeHistory] = Field(..., alias="ChallengeHistories")
+
+
+class ChallengeTrackerDetailList(OtfBaseModel):
+    details: list[ChallengeTrackerDetail]

otf_api/models/responses/classes.py

@@ -0,0 +1,57 @@
+from datetime import datetime
+
+from otf_api.models.base import OtfBaseModel
+
+
+class Address(OtfBaseModel):
+    line1: str
+    city: str
+    state: str
+    country: str
+    postal_code: str
+
+
+class Studio(OtfBaseModel):
+    id: str
+    name: str
+    mbo_studio_id: str
+    time_zone: str
+    currency_code: str
+    address: Address
+    phone_number: str
+    latitude: float
+    longitude: float
+
+
+class Coach(OtfBaseModel):
+    mbo_staff_id: str
+    first_name: str
+    image_url: str | None = None
+
+
+class OtfClass(OtfBaseModel):
+    id: str
+    ot_base_class_uuid: str
+    starts_at: datetime
+    starts_at_local: datetime
+    ends_at: datetime
+    ends_at_local: datetime
+    name: str
+    type: str
+    studio: Studio
+    coach: Coach
+    max_capacity: int
+    booking_capacity: int
+    waitlist_size: int
+    full: bool
+    waitlist_available: bool
+    canceled: bool
+    mbo_class_id: str
+    mbo_class_schedule_id: str
+    mbo_class_description_id: str
+    created_at: datetime
+    updated_at: datetime
+
+
+class OtfClassList(OtfBaseModel):
+    classes: list[OtfClass]

otf_api/models/responses/enums.py

@@ -0,0 +1,87 @@
+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
+    Rower = 4
+    Bike = 5
+    WeightFloor = 6
+    PowerWalker = 7
+
+
+class ChallengeType(int, Enum):
+    Other = 0
+    DriTri = 2
+    MarathonMonth = 5
+    HellWeek = 52
+    Mayhem = 58
+    TwelveDaysOfFitness = 63
+    Transformation = 64
+    RemixInSix = 65
+    Push = 66
+    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"
+    LateCancelled = "Late Cancelled"
+
+    @classmethod
+    def all_statuses(cls) -> list[str]:
+        return list(cls.__members__.values())
+
+
+class HistoryClassStatus(str, Enum):
+    CheckedIn = "Checked In"
+    CancelCheckinPending = "Cancel Checkin Pending"
+    CancelCheckinRequested = "Cancel Checkin Requested"
+    LateCancelled = "Late Cancelled"
+    Booked = "Booked"
+    Waitlisted = "Waitlisted"
+    CheckinPending = "Checkin Pending"
+    CheckinRequested = "Checkin Requested"
+    CheckinCancelled = "Checkin Cancelled"
+    Pending = "Pending"
+    Confirmed = "Confirmed"
+    Requested = "Requested"
+
+    @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()