otf-api 0.6.0__py3-none-any.whl → 0.6.2__py3-none-any.whl

otf_api/__init__.py

@@ -6,7 +6,7 @@ from loguru import logger
 from .api import Otf
 from .auth import OtfUser
 
-__version__ = "0.6.0"
+__version__ = "0.6.2"
 
 
 __all__ = ["Otf", "OtfUser"]

otf_api/models/base.py

@@ -1,141 +1,14 @@
-import inspect
-import typing
-from typing import ClassVar, TypeVar
+from typing import ClassVar
 
-from box import Box
 from pydantic import BaseModel, ConfigDict
 
-if typing.TYPE_CHECKING:
-    from pydantic.main import IncEx
 
-T = TypeVar("T", bound="OtfItemBase")
-
-
-class BetterDumperMixin:
-    """A better dumper for Pydantic models that includes properties in the dumped data. Must be mixed
-    into a Pydantic model, as it overrides the `model_dump` method.
-
-    Includes support for nested models, and has an option to not include properties when dumping.
-    """
-
-    def get_properties(self) -> list[str]:
-        """Get the properties of the model."""
-        cls = type(self)
-
-        properties: list[str] = []
-        methods = inspect.getmembers(self, lambda f: not (inspect.isroutine(f)))
-        for prop_name, _ in methods:
-            if hasattr(cls, prop_name) and isinstance(getattr(cls, prop_name), property):
-                properties.append(prop_name)
-
-        return properties
-
-    @typing.overload
-    def model_dump(
-        self,
-        *,
-        mode: typing.Literal["json", "python"] | str = "python",
-        include: "IncEx" = None,
-        exclude: "IncEx" = None,
-        by_alias: bool = False,
-        exclude_unset: bool = False,
-        exclude_defaults: bool = False,
-        exclude_none: bool = False,
-        round_trip: bool = False,
-        warnings: bool = True,
-        include_properties: bool = True,
-    ) -> Box[str, typing.Any]: ...
-
-    @typing.overload
-    def model_dump(
-        self,
-        *,
-        mode: typing.Literal["json", "python"] | str = "python",
-        include: "IncEx" = None,
-        exclude: "IncEx" = None,
-        by_alias: bool = False,
-        exclude_unset: bool = False,
-        exclude_defaults: bool = False,
-        exclude_none: bool = False,
-        round_trip: bool = False,
-        warnings: bool = True,
-        include_properties: bool = False,
-    ) -> dict[str, typing.Any]: ...
-
-    def model_dump(
-        self,
-        *,
-        mode: typing.Literal["json", "python"] | str = "python",
-        include: "IncEx" = None,
-        exclude: "IncEx" = None,
-        by_alias: bool = False,
-        exclude_unset: bool = False,
-        exclude_defaults: bool = False,
-        exclude_none: bool = False,
-        round_trip: bool = False,
-        warnings: bool = True,
-        include_properties: bool = True,
-    ) -> dict[str, typing.Any] | Box[str, typing.Any]:
-        """Usage docs: https://docs.pydantic.dev/2.4/concepts/serialization/#modelmodel_dump
-
-        Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
-
-        Args:
-            mode: The mode in which `to_python` should run.
-                If mode is 'json', the dictionary will only contain JSON serializable types.
-                If mode is 'python', the dictionary may contain any Python objects.
-            include: A list of fields to include in the output.
-            exclude: A list of fields to exclude from the output.
-            by_alias: Whether to use the field's alias in the dictionary key if defined.
-            exclude_unset: Whether to exclude fields that are unset or None from the output.
-            exclude_defaults: Whether to exclude fields that are set to their default value from the output.
-            exclude_none: Whether to exclude fields that have a value of `None` from the output.
-            round_trip: Whether to enable serialization and deserialization round-trip support.
-            warnings: Whether to log warnings when invalid fields are encountered.
-            include_properties: Whether to include properties in the dumped data.
-
-        Returns:
-            A dictionary representation of the model. Will be a `Box` if `include_properties` is `True`, otherwise a
-            regular dictionary.
-
-        """
-        dumped_data = typing.cast(BaseModel, super()).model_dump(
-            mode=mode,
-            include=include,
-            exclude=exclude,
-            by_alias=by_alias,
-            exclude_unset=exclude_unset,
-            exclude_defaults=exclude_defaults,
-            exclude_none=exclude_none,
-            round_trip=round_trip,
-            warnings=warnings,
-        )
-
-        if not include_properties:
-            return dumped_data
-
-        properties = self.get_properties()
-
-        # set properties to their values
-        for prop_name in properties:
-            dumped_data[prop_name] = getattr(self, prop_name)
-
-        # if the property is a Pydantic model, dump it as well
-        for k, v in dumped_data.items():
-            if issubclass(type(getattr(self, k)), BaseModel):
-                dumped_data[k] = getattr(self, k).model_dump()
-            elif hasattr(v, "model_dump"):
-                dumped_data[k] = v.model_dump()
-
-        return Box(dumped_data)
-
-
-class OtfItemBase(BetterDumperMixin, BaseModel):
-    model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
+class OtfItemBase(BaseModel):
+    model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="allow")
 
 
 class OtfListBase(BaseModel):
-    model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
+    model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True, extra="allow")
     collection_field: ClassVar[str] = "data"
 
     @property

otf_api/models/responses/body_composition_list.py

@@ -5,6 +5,8 @@ from enum import Enum
 import pint
 from pydantic import BaseModel, ConfigDict, Field, field_validator
 
+from otf_api.models.base import OtfItemBase, OtfListBase
+
 ureg = pint.UnitRegistry()
 
 DEFAULT_WEIGHT_DIVIDERS = [55.0, 70.0, 85.0, 100.0, 115.0, 130.0, 145.0, 160.0, 175.0, 190.0, 205.0]
@@ -98,7 +100,7 @@ def get_body_fat_percent_dividers_female(age: int) -> list[float]:
             return [0.0, 0.0, 0.0, 0.0]
 
 
-class LeanBodyMass(BaseModel):
+class LeanBodyMass(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     left_arm: float = Field(..., alias="lbmOfLeftArm")
     left_leg: float = Field(..., alias="lbmOfLeftLeg")
@@ -107,7 +109,7 @@ class LeanBodyMass(BaseModel):
     trunk: float = Field(..., alias="lbmOfTrunk")
 
 
-class LeanBodyMassPercent(BaseModel):
+class LeanBodyMassPercent(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     left_arm: float = Field(..., alias="lbmPercentOfLeftArm")
     left_leg: float = Field(..., alias="lbmPercentOfLeftLeg")
@@ -116,7 +118,7 @@ class LeanBodyMassPercent(BaseModel):
     trunk: float = Field(..., alias="lbmPercentOfTrunk")
 
 
-class BodyFatMass(BaseModel):
+class BodyFatMass(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     control: float = Field(..., alias="bfmControl")
     left_arm: float = Field(..., alias="bfmOfLeftArm")
@@ -126,7 +128,7 @@ class BodyFatMass(BaseModel):
     trunk: float = Field(..., alias="bfmOfTrunk")
 
 
-class BodyFatMassPercent(BaseModel):
+class BodyFatMassPercent(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     left_arm: float = Field(..., alias="bfmPercentOfLeftArm")
     left_leg: float = Field(..., alias="bfmPercentOfLeftLeg")
@@ -135,7 +137,7 @@ class BodyFatMassPercent(BaseModel):
     trunk: float = Field(..., alias="bfmPercentOfTrunk")
 
 
-class TotalBodyWeight(BaseModel):
+class TotalBodyWeight(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     right_arm: float = Field(..., alias="tbwOfRightArm")
     left_arm: float = Field(..., alias="tbwOfLeftArm")
@@ -144,7 +146,7 @@ class TotalBodyWeight(BaseModel):
     left_leg: float = Field(..., alias="tbwOfLeftLeg")
 
 
-class IntraCellularWater(BaseModel):
+class IntraCellularWater(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     right_arm: float = Field(..., alias="icwOfRightArm")
     left_arm: float = Field(..., alias="icwOfLeftArm")
@@ -153,7 +155,7 @@ class IntraCellularWater(BaseModel):
     left_leg: float = Field(..., alias="icwOfLeftLeg")
 
 
-class ExtraCellularWater(BaseModel):
+class ExtraCellularWater(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     right_arm: float = Field(..., alias="ecwOfRightArm")
     left_arm: float = Field(..., alias="ecwOfLeftArm")
@@ -162,7 +164,7 @@ class ExtraCellularWater(BaseModel):
     left_leg: float = Field(..., alias="ecwOfLeftLeg")
 
 
-class ExtraCellularWaterOverTotalBodyWater(BaseModel):
+class ExtraCellularWaterOverTotalBodyWater(OtfItemBase):
     model_config: ConfigDict = ConfigDict(extra="ignore")
     right_arm: float = Field(..., alias="ecwOverTBWOfRightArm")
     left_arm: float = Field(..., alias="ecwOverTBWOfLeftArm")
@@ -171,7 +173,7 @@ class ExtraCellularWaterOverTotalBodyWater(BaseModel):
     left_leg: float = Field(..., alias="ecwOverTBWOfLeftLeg")
 
 
-class BodyCompositionData(BaseModel):
+class BodyCompositionData(OtfItemBase):
     member_uuid: str = Field(..., alias="memberUUId")
     member_id: str = Field(..., alias="memberId")
     scan_result_uuid: str = Field(..., alias="scanResultUUId")
@@ -300,5 +302,5 @@ class BodyCompositionData(BaseModel):
         )
 
 
-class BodyCompositionList(BaseModel):
+class BodyCompositionList(OtfListBase):
     data: list[BodyCompositionData]

otf_api/models/responses/book_class.py

@@ -1,19 +1,21 @@
 from datetime import datetime
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 
+from otf_api.models.base import OtfItemBase
 
-class MemberProfile(BaseModel):
+
+class MemberProfile(OtfItemBase):
     is_latest_agreement_signed: bool = Field(..., alias="isLatestAgreementSigned")
 
 
-class StudioProfiles(BaseModel):
+class StudioProfiles(OtfItemBase):
     studio_id: int = Field(..., alias="studioId")
     is_franchise_agreement_enabled: int = Field(..., alias="isFranchiseAgreementEnabled")
 
 
-class HomeStudio(BaseModel):
+class HomeStudio(OtfItemBase):
     studio_uuid: str = Field(..., alias="studioUUId")
     studio_name: str = Field(..., alias="studioName")
     description: str
@@ -28,7 +30,7 @@ class HomeStudio(BaseModel):
     studio_profiles: StudioProfiles = Field(..., alias="studioProfiles")
 
 
-class MemberService(BaseModel):
+class MemberService(OtfItemBase):
     member_service_id: int = Field(..., alias="memberServiceId")
     member_service_uuid: str = Field(..., alias="memberServiceUUId")
     service_name: str = Field(..., alias="serviceName")
@@ -49,13 +51,13 @@ class MemberService(BaseModel):
     is_deleted: bool = Field(..., alias="isDeleted")
 
 
-class ServiceItem(BaseModel):
+class ServiceItem(OtfItemBase):
     service_id: int = Field(..., alias="serviceId")
     name: str
     member_service: MemberService = Field(..., alias="MemberService")
 
 
-class Member(BaseModel):
+class Member(OtfItemBase):
     member_id: int = Field(..., alias="memberId")
     member_uuid: str = Field(..., alias="memberUUId")
     cognito_id: str = Field(..., alias="cognitoId")
@@ -107,7 +109,7 @@ class Member(BaseModel):
     notes: str
 
 
-class Studio(BaseModel):
+class Studio(OtfItemBase):
     studio_uuid: str = Field(..., alias="studioUUId")
     studio_name: str = Field(..., alias="studioName")
     description: str
@@ -121,12 +123,12 @@ class Studio(BaseModel):
     cr_waitlist_flag_last_updated: datetime = Field(..., alias="crWaitlistFlagLastUpdated")
 
 
-class Location(BaseModel):
+class Location(OtfItemBase):
     location_id: int = Field(..., alias="locationId")
     location_uuid: str = Field(..., alias="locationUUId")
 
 
-class Coach(BaseModel):
+class Coach(OtfItemBase):
     coach_uuid: str = Field(..., alias="coachUUId")
     first_name: str = Field(..., alias="firstName")
     last_name: str = Field(..., alias="lastName")
@@ -134,7 +136,7 @@ class Coach(BaseModel):
     name: str
 
 
-class Class(BaseModel):
+class Class(OtfItemBase):
     class_id: int = Field(..., alias="classId")
     class_uuid: str = Field(..., alias="classUUId")
     mbo_studio_id: int = Field(..., alias="mboStudioId")
@@ -175,16 +177,16 @@ class Class(BaseModel):
     attributes: dict[str, Any]
 
 
-class Class1(BaseModel):
+class Class1(OtfItemBase):
     mbo_studio_id: int = Field(..., alias="mboStudioId")
     studio_uuid: str = Field(..., alias="studioUUId")
 
 
-class CustomData(BaseModel):
+class CustomData(OtfItemBase):
     otf_class: Class1 = Field(..., alias="class")
 
 
-class SavedBooking(BaseModel):
+class SavedBooking(OtfItemBase):
     class_booking_id: int = Field(..., alias="classBookingId")
     class_booking_uuid: str = Field(..., alias="classBookingUUId")
     studio_id: int = Field(..., alias="studioId")
@@ -211,19 +213,19 @@ class SavedBooking(BaseModel):
     attributes: dict[str, Any]
 
 
-class FieldModel(BaseModel):
+class FieldModel(OtfItemBase):
     xsi_nil: str = Field(..., alias="xsiNil")
 
 
-class FacilitySquareFeet(BaseModel):
+class FacilitySquareFeet(OtfItemBase):
     field_: FieldModel
 
 
-class TreatmentRooms(BaseModel):
+class TreatmentRooms(OtfItemBase):
     field_: FieldModel
 
 
-class Location1(BaseModel):
+class Location1(OtfItemBase):
     site_id: str | Any = Field(..., alias="siteId")
     business_description: str | Any = Field(..., alias="businessDescription")
     additional_image_ur_ls: str | Any = Field(..., alias="additionalImageUrLs")
@@ -247,38 +249,38 @@ class Location1(BaseModel):
     longitude: str
 
 
-class MaxCapacity(BaseModel):
+class MaxCapacity(OtfItemBase):
     field_: FieldModel | Any
 
 
-class WebCapacity(BaseModel):
+class WebCapacity(OtfItemBase):
     field_: FieldModel | Any
 
 
-class TotalBookedWaitlist(BaseModel):
+class TotalBookedWaitlist(OtfItemBase):
     field_: FieldModel | Any
 
 
-class WebBooked(BaseModel):
+class WebBooked(OtfItemBase):
     field_: FieldModel | Any
 
 
-class SemesterId(BaseModel):
+class SemesterId(OtfItemBase):
     field_: FieldModel | Any
 
 
-class Program(BaseModel):
+class Program(OtfItemBase):
     id: str
     name: str
     schedule_type: str = Field(..., alias="scheduleType")
     cancel_offset: str = Field(..., alias="cancelOffset")
 
 
-class DefaultTimeLength(BaseModel):
+class DefaultTimeLength(OtfItemBase):
     field_: FieldModel
 
 
-class SessionType(BaseModel):
+class SessionType(OtfItemBase):
     default_time_length: DefaultTimeLength = Field(..., alias="defaultTimeLength")
     program_id: str = Field(..., alias="programId")
     num_deducted: str = Field(..., alias="numDeducted")
@@ -289,7 +291,7 @@ class SessionType(BaseModel):
     available_for_add_on: str = Field(..., alias="availableForAddOn")
 
 
-class ClassDescription(BaseModel):
+class ClassDescription(OtfItemBase):
     id: str
     name: str
     description: str
@@ -300,7 +302,7 @@ class ClassDescription(BaseModel):
     session_type: SessionType = Field(..., alias="sessionType")
 
 
-class Staff(BaseModel):
+class Staff(OtfItemBase):
     email: str
     mobile_phone: str = Field(..., alias="mobilePhone")
     state: str
@@ -318,25 +320,25 @@ class Staff(BaseModel):
     is_male: str = Field(..., alias="isMale")
 
 
-class AgreementDate(BaseModel):
+class AgreementDate(OtfItemBase):
     field_: FieldModel
 
 
-class ReleasedBy(BaseModel):
+class ReleasedBy(OtfItemBase):
     field_: FieldModel
 
 
-class Liability(BaseModel):
+class Liability(OtfItemBase):
     is_released: str = Field(..., alias="isReleased")
     agreement_date: AgreementDate = Field(..., alias="agreementDate")
     released_by: ReleasedBy = Field(..., alias="releasedBy")
 
 
-class FirstAppointmentDate(BaseModel):
+class FirstAppointmentDate(OtfItemBase):
     field_: FieldModel
 
 
-class Client(BaseModel):
+class Client(OtfItemBase):
     notes: str
     mobile_provider: str = Field(..., alias="mobileProvider")
     appointment_gender_preference: str = Field(..., alias="appointmentGenderPreference")
@@ -369,7 +371,7 @@ class Client(BaseModel):
     member_uuid: str = Field(..., alias="memberUUId")
 
 
-class MboClass(BaseModel):
+class MboClass(OtfItemBase):
     class_schedule_id: str = Field(..., alias="classScheduleId")
     location: Location1
     max_capacity: MaxCapacity = Field(..., alias="maxCapacity")
@@ -394,12 +396,12 @@ class MboClass(BaseModel):
     client: Client
 
 
-class MboResponseItem(BaseModel):
+class MboResponseItem(OtfItemBase):
     class_booking_uuid: str | Any = Field(..., alias="classBookingUUId")
     action: str | Any
     otf_class: MboClass | Any = Field(..., alias="class")
 
 
-class BookClass(BaseModel):
+class BookClass(OtfItemBase):
     saved_bookings: list[SavedBooking] = Field(..., alias="savedBookings")
     mbo_response: list[MboResponseItem] = Field(..., alias="mboResponse")

otf_api/models/responses/cancel_booking.py

@@ -1,9 +1,11 @@
 from datetime import datetime
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 
+from otf_api.models.base import OtfItemBase
 
-class Studio(BaseModel):
+
+class Studio(OtfItemBase):
     studio_uuid: str = Field(..., alias="studioUUId")
     studio_name: str = Field(..., alias="studioName")
     description: str
@@ -17,7 +19,7 @@ class Studio(BaseModel):
     cr_waitlist_flag_last_updated: datetime = Field(..., alias="crWaitlistFlagLastUpdated")
 
 
-class Coach(BaseModel):
+class Coach(OtfItemBase):
     coach_uuid: str = Field(..., alias="coachUUId")
     name: str
     first_name: str = Field(..., alias="firstName")
@@ -25,7 +27,7 @@ class Coach(BaseModel):
     mbo_coach_id: int = Field(..., alias="mboCoachId")
 
 
-class Class(BaseModel):
+class Class(OtfItemBase):
     class_uuid: str = Field(..., alias="classUUId")
     name: str
     description: str
@@ -40,7 +42,7 @@ class Class(BaseModel):
     coach: Coach
 
 
-class HomeStudio(BaseModel):
+class HomeStudio(OtfItemBase):
     studio_uuid: str = Field(..., alias="studioUUId")
     studio_name: str = Field(..., alias="studioName")
     description: str
@@ -54,7 +56,7 @@ class HomeStudio(BaseModel):
     cr_waitlist_flag_last_updated: datetime = Field(..., alias="crWaitlistFlagLastUpdated")
 
 
-class Member(BaseModel):
+class Member(OtfItemBase):
     member_id: int = Field(..., alias="memberId")
     member_uuid: str = Field(..., alias="memberUUId")
     email: str
@@ -67,7 +69,7 @@ class Member(BaseModel):
     home_studio: HomeStudio = Field(..., alias="homeStudio")
 
 
-class CancelBooking(BaseModel):
+class CancelBooking(OtfItemBase):
     class_booking_id: int = Field(..., alias="classBookingId")
     class_booking_uuid: str = Field(..., alias="classBookingUUId")
     studio_id: int = Field(..., alias="studioId")

otf_api/models/responses/challenge_tracker_detail.py

@@ -1,9 +1,9 @@
 from datetime import datetime
-from typing import Any
+from typing import Any, ClassVar
 
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class MetricEntry(OtfItemBase):
@@ -64,5 +64,6 @@ class ChallengeTrackerDetail(OtfItemBase):
     challenge_histories: list[ChallengeHistory] = Field(..., alias="ChallengeHistories")
 
 
-class ChallengeTrackerDetailList(OtfItemBase):
+class ChallengeTrackerDetailList(OtfListBase):
+    collection_field: ClassVar[str] = "details"
     details: list[ChallengeTrackerDetail]

otf_api/models/responses/favorite_studios.py

@@ -1,8 +1,9 @@
 from datetime import datetime
+from typing import ClassVar
 
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class Location(OtfItemBase):
@@ -94,7 +95,8 @@ class FavoriteStudio(OtfItemBase):
     studio_location: StudioLocation = Field(..., alias="studioLocation")
 
 
-class FavoriteStudioList(OtfItemBase):
+class FavoriteStudioList(OtfListBase):
+    collection_field: ClassVar[str] = "studios"
     studios: list[FavoriteStudio]
 
     @property

otf_api/models/responses/lifetime_stats.py

@@ -1,6 +1,8 @@
 from enum import Enum
 
-from pydantic import BaseModel, Field
+from pydantic import Field
+
+from otf_api.models.base import OtfItemBase
 
 
 class StatsTime(str, Enum):
@@ -19,20 +21,20 @@ class StatsType(str, Enum):
     All = "allStats"
 
 
-class OutStudioMixin(BaseModel):
+class OutStudioMixin(OtfItemBase):
     walking_distance: float = Field(..., alias="walkingDistance")
     running_distance: float = Field(..., alias="runningDistance")
     cycling_distance: float = Field(..., alias="cyclingDistance")
 
 
-class InStudioMixin(BaseModel):
+class InStudioMixin(OtfItemBase):
     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):
+class BaseStatsData(OtfItemBase):
     calories: float
     splat_point: float = Field(..., alias="splatPoint")
     total_black_zone: float = Field(..., alias="totalBlackZone")
@@ -56,7 +58,7 @@ class AllStatsData(OutStudioMixin, InStudioMixin, BaseStatsData):
     pass
 
 
-class OutStudioTimeStats(BaseModel):
+class OutStudioTimeStats(OtfItemBase):
     last_year: OutStudioStatsData = Field(..., alias="lastYear")
     this_year: OutStudioStatsData = Field(..., alias="thisYear")
     last_month: OutStudioStatsData = Field(..., alias="lastMonth")
@@ -66,7 +68,7 @@ class OutStudioTimeStats(BaseModel):
     all_time: OutStudioStatsData = Field(..., alias="allTime")
 
 
-class InStudioTimeStats(BaseModel):
+class InStudioTimeStats(OtfItemBase):
     last_year: InStudioStatsData = Field(..., alias="lastYear")
     this_year: InStudioStatsData = Field(..., alias="thisYear")
     last_month: InStudioStatsData = Field(..., alias="lastMonth")
@@ -76,7 +78,7 @@ class InStudioTimeStats(BaseModel):
     all_time: InStudioStatsData = Field(..., alias="allTime")
 
 
-class AllStatsTimeStats(BaseModel):
+class AllStatsTimeStats(OtfItemBase):
     last_year: AllStatsData = Field(..., alias="lastYear")
     this_year: AllStatsData = Field(..., alias="thisYear")
     last_month: AllStatsData = Field(..., alias="lastMonth")
@@ -86,7 +88,7 @@ class AllStatsTimeStats(BaseModel):
     all_time: AllStatsData = Field(..., alias="allTime")
 
 
-class StatsResponse(BaseModel):
+class StatsResponse(OtfItemBase):
     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

@@ -101,7 +101,7 @@ class MemberDetail(OtfItemBase):
     state: None
     postal_code: None = Field(..., alias="postalCode")
     phone_number: str = Field(..., alias="phoneNumber")
-    home_phone: str = Field(..., alias="homePhone")
+    home_phone: str | None = Field(..., alias="homePhone")
     work_phone: None = Field(..., alias="workPhone")
     phone_type: None = Field(..., alias="phoneType")
     birth_day: date | str = Field(..., alias="birthDay")

otf_api/models/responses/member_purchases.py

@@ -2,7 +2,7 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class Location(OtfItemBase):
@@ -131,5 +131,5 @@ class MemberPurchase(OtfItemBase):
     studio: Studio
 
 
-class MemberPurchaseList(OtfItemBase):
+class MemberPurchaseList(OtfListBase):
     data: list[MemberPurchase]

otf_api/models/responses/out_of_studio_workout_history.py

@@ -2,7 +2,7 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class WorkoutType(OtfItemBase):
@@ -37,5 +37,5 @@ class OutOfStudioWorkoutHistory(OtfItemBase):
     max_heartrate: int = Field(..., alias="maxHeartrate")
 
 
-class OutOfStudioWorkoutHistoryList(OtfItemBase):
+class OutOfStudioWorkoutHistoryList(OtfListBase):
     data: list[OutOfStudioWorkoutHistory]

otf_api/models/responses/performance_summary_detail.py

@@ -1,7 +1,9 @@
-from pydantic import BaseModel, Field
+from pydantic import Field
 
+from otf_api.models.base import OtfItemBase
 
-class ZoneTimeMinutes(BaseModel):
+
+class ZoneTimeMinutes(OtfItemBase):
     gray: int
     blue: int
     green: int
@@ -9,7 +11,7 @@ class ZoneTimeMinutes(BaseModel):
     red: int
 
 
-class HeartRate(BaseModel):
+class HeartRate(OtfItemBase):
     max_hr: int
     peak_hr: int
     peak_hr_percent: int
@@ -17,19 +19,19 @@ class HeartRate(BaseModel):
     avg_hr_percent: int
 
 
-class PerformanceMetricFloat(BaseModel):
+class PerformanceMetricFloat(OtfItemBase):
     display_value: float
     display_unit: str
     metric_value: float
 
 
-class PerformanceMetricString(BaseModel):
+class PerformanceMetricString(OtfItemBase):
     display_value: str
     display_unit: str
     metric_value: str
 
 
-class BaseEquipment(BaseModel):
+class BaseEquipment(OtfItemBase):
     avg_pace: PerformanceMetricString
     avg_speed: PerformanceMetricFloat
     max_pace: PerformanceMetricString
@@ -50,12 +52,12 @@ class Rower(BaseEquipment):
     max_cadence: PerformanceMetricFloat
 
 
-class EquipmentData(BaseModel):
+class EquipmentData(OtfItemBase):
     treadmill: Treadmill
     rower: Rower
 
 
-class Details(BaseModel):
+class Details(OtfItemBase):
     calories_burned: int
     splat_points: int
     step_count: int
@@ -65,12 +67,12 @@ class Details(BaseModel):
     equipment_data: EquipmentData
 
 
-class Class(BaseModel):
+class Class(OtfItemBase):
     starts_at_local: str
     name: str
 
 
-class PerformanceSummaryDetail(BaseModel):
+class PerformanceSummaryDetail(OtfItemBase):
     id: str
     details: Details
     ratable: bool

otf_api/models/responses/performance_summary_list.py

@@ -1,6 +1,8 @@
+from typing import ClassVar
+
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class ZoneTimeMinutes(OtfItemBase):
@@ -34,6 +36,7 @@ class Class(OtfItemBase):
     ot_base_class_uuid: str | None = None
     starts_at_local: str
     name: str | None = None
+    type: str | None = None
     coach: Coach
     studio: Studio
 
@@ -63,5 +66,6 @@ class PerformanceSummaryEntry(OtfItemBase):
     ratings: Ratings | None = None
 
 
-class PerformanceSummaryList(OtfItemBase):
+class PerformanceSummaryList(OtfListBase):
+    collection_field: ClassVar[str] = "summaries"
     summaries: list[PerformanceSummaryEntry]

otf_api/models/responses/studio_detail.py

@@ -1,8 +1,9 @@
 from datetime import datetime
+from typing import ClassVar
 
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class Country(OtfItemBase):
@@ -107,5 +108,6 @@ class Pagination(OtfItemBase):
     total_pages: int = Field(..., alias="totalPages")
 
 
-class StudioDetailList(OtfItemBase):
+class StudioDetailList(OtfListBase):
+    collection_field: ClassVar[str] = "studios"
     studios: list[StudioDetail]

otf_api/models/responses/studio_services.py

@@ -2,7 +2,7 @@ from datetime import datetime
 
 from pydantic import Field
 
-from otf_api.models.base import OtfItemBase
+from otf_api.models.base import OtfItemBase, OtfListBase
 
 
 class Currency(OtfItemBase):
@@ -53,5 +53,5 @@ class StudioService(OtfItemBase):
     studio: Studio
 
 
-class StudioServiceList(OtfItemBase):
+class StudioServiceList(OtfListBase):
     data: list[StudioService]

otf_api/models/responses/telemetry.py

@@ -25,6 +25,14 @@ class TreadData(OtfItemBase):
     agg_tread_distance: int = Field(..., alias="aggTreadDistance")
 
 
+class RowData(OtfItemBase):
+    row_speed: float = Field(..., alias="rowSpeed")
+    row_pps: float = Field(..., alias="rowPps")
+    row_Spm: float = Field(..., alias="rowSpm")
+    agg_row_distance: int = Field(..., alias="aggRowDistance")
+    row_pace: int = Field(..., alias="rowPace")
+
+
 class TelemetryItem(OtfItemBase):
     relative_timestamp: int = Field(..., alias="relativeTimestamp")
     hr: int
@@ -36,6 +44,7 @@ class TelemetryItem(OtfItemBase):
         description="The timestamp of the telemetry item, calculated from the class start time and relative timestamp.",
     )
     tread_data: TreadData | None = Field(None, alias="treadData")
+    row_data: RowData | None = Field(None, alias="rowData")
 
 
 class Telemetry(OtfItemBase):

{otf_api-0.6.0.dist-info → otf_api-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: otf-api
-Version: 0.6.0
+Version: 0.6.2
 Summary: Python OrangeTheory Fitness API Client
 License: MIT
 Author: Jessica Smith
@@ -18,7 +18,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: aiohttp (==3.8.*)
+Requires-Dist: aiohttp (==3.10.*)
 Requires-Dist: humanize (>=4.9.0,<5.0.0)
 Requires-Dist: inflection (==0.5.*)
 Requires-Dist: loguru (==0.7.2)
@@ -26,7 +26,6 @@ Requires-Dist: pendulum (>=3.0.0,<4.0.0)
 Requires-Dist: pint (==0.24.*)
 Requires-Dist: pycognito (==2024.5.1)
 Requires-Dist: pydantic (==2.7.3)
-Requires-Dist: python-box (>=7.2.0,<8.0.0)
 Project-URL: Documentation, https://otf-api.readthedocs.io/en/stable/
 Description-Content-Type: text/markdown
 

otf_api-0.6.2.dist-info/RECORD

@@ -0,0 +1,35 @@
+otf_api/__init__.py,sha256=z4nKmmBKrL1BuMh3E_emGRQUPyotvOREIXf5RTnHzU4,237
+otf_api/api.py,sha256=QlRHXDwzbB97aCfacb_9FVox-5AuPLMweRQAZkz-EE0,34885
+otf_api/auth.py,sha256=XzwLSi5M3DyG7bE7DmWAzXF2y6fkJyAZxHUA9lpW25M,10231
+otf_api/models/__init__.py,sha256=3GHBOirQA4yu06cgD9pYmCU8u8_F9nxNHeSXDuFpe5A,1428
+otf_api/models/base.py,sha256=gsMf3XGKqc68CRC-Mp3ARdnXKCpbWWGttZ8pfUwuEu0,664
+otf_api/models/responses/__init__.py,sha256=xxwz-JwRd0upmI0VNdvInbAm2FOQvPo3pS0SEhWfkI4,1947
+otf_api/models/responses/body_composition_list.py,sha256=N1amk4sWzgiBFmnCUUlMGSwOh_XGucqW_8MvE0XsRKY,12271
+otf_api/models/responses/book_class.py,sha256=N3KydWoLOYpkG87O4qMqaBH27oHm3PwCzC60jCXUfHo,15517
+otf_api/models/responses/bookings.py,sha256=XwW6blHpw9imtXRnQJYahUgfrAeOcGZqfYE-oJZ8510,8467
+otf_api/models/responses/cancel_booking.py,sha256=nrvNwhlSw3tbd4qw0Jbgf0-OTjW1Qjg_ynNvC8fWPJQ,3905
+otf_api/models/responses/challenge_tracker_content.py,sha256=KKpSWyyg3viN0vf1Sg2zTMlMZExLe3I6wowmUPWvRCA,1423
+otf_api/models/responses/challenge_tracker_detail.py,sha256=2tHJTN2Mu8WenanuGa-P4Gijd7qbwI-jQlwPNqfhv2Q,3119
+otf_api/models/responses/classes.py,sha256=VxesbFyfRhohwkjiclqTtMPl8bNc5PJajveTHtDBQ2A,4731
+otf_api/models/responses/enums.py,sha256=Au8XhD-4T8ljiueUykFDc6Qz7kOoTlJ_kiDEx7nLVLM,1191
+otf_api/models/responses/favorite_studios.py,sha256=Ho6K_qhkp_MyS8xGiYBp3DeBdcL7xQh6_ZpaKW8QwTY,5071
+otf_api/models/responses/latest_agreement.py,sha256=aE8hbWE4Pgguw4Itah7a1SqwOLpJ6t9oODFwLQ8Wzo0,774
+otf_api/models/responses/lifetime_stats.py,sha256=n8pZOwvc2boGa98oAde4coJNjmv7V4Ekt3olTj28BUk,3387
+otf_api/models/responses/member_detail.py,sha256=qgP_gaiIi6Jr5SI7RSrj8l9p6aCbVK0fJX2LgI5Gazk,6031
+otf_api/models/responses/member_membership.py,sha256=_z301T9DrdQW9vIgnx_LeZmkRhvMVhkxrn_v6DDfCUk,995
+otf_api/models/responses/member_purchases.py,sha256=ddKC8NFVwksNMSJWco-Ekiy7SmqFGkU8nmWV_5Ur0pA,6098
+otf_api/models/responses/out_of_studio_workout_history.py,sha256=Nl2KGgErkI0rMpIYD8xisFZO_vp_Ffgflx2putIKebU,1722
+otf_api/models/responses/performance_summary_detail.py,sha256=U7GbVet_klwv7Joc8DiBJw4tjb3OmjoT19KGxorrNYo,1637
+otf_api/models/responses/performance_summary_list.py,sha256=JDJoQEYx9llg43YjZc7AeMatUNJ6Ah40MjoVZt0-dkQ,1354
+otf_api/models/responses/studio_detail.py,sha256=-ZCTCJ3MovI4ChHspvE2pG4OblvuZR_wAfpg5GNBa7U,5096
+otf_api/models/responses/studio_services.py,sha256=cnnSljjOLauWAdvbf3ujKfXkrCvBsQGCXoBTARhmIqQ,1849
+otf_api/models/responses/telemetry.py,sha256=MTI9fV9LniWU73xRfV_ZcdQeaeDLuaYMcQgL239lEAI,2012
+otf_api/models/responses/telemetry_hr_history.py,sha256=vDcLb4wTHVBw8O0mGblUujHfJegkflOCWW-bnTXNCI0,763
+otf_api/models/responses/telemetry_max_hr.py,sha256=xKxH0fIlOqFyZv8UW98XsxF-GMoIs9gnCTAbu88ZQtg,266
+otf_api/models/responses/total_classes.py,sha256=WrKkWbq0eK8J0RC4qhZ5kmXnv_ZTDbyzsoRm7XKGlss,288
+otf_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otf_api-0.6.2.dist-info/AUTHORS.md,sha256=FcNWMxpe8KDuTq4Qau0SUXsabQwGs9TGnMp1WkXRnj8,123
+otf_api-0.6.2.dist-info/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
+otf_api-0.6.2.dist-info/METADATA,sha256=0tZaD7tUe0X0oziRVennPiFXE1NhoLHXYZOeWXGhvGI,1989
+otf_api-0.6.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+otf_api-0.6.2.dist-info/RECORD,,

otf_api-0.6.0.dist-info/RECORD

@@ -1,35 +0,0 @@
-otf_api/__init__.py,sha256=eRrcOgzcFV7KIhf6KwQ5AnvOaGfAam3AKbP01hAFOys,237
-otf_api/api.py,sha256=QlRHXDwzbB97aCfacb_9FVox-5AuPLMweRQAZkz-EE0,34885
-otf_api/auth.py,sha256=XzwLSi5M3DyG7bE7DmWAzXF2y6fkJyAZxHUA9lpW25M,10231
-otf_api/models/__init__.py,sha256=3GHBOirQA4yu06cgD9pYmCU8u8_F9nxNHeSXDuFpe5A,1428
-otf_api/models/base.py,sha256=FrYzMVA4-EWhaKwzem8bEAzRu_jK-RTCkDj5ihTSkZM,5442
-otf_api/models/responses/__init__.py,sha256=xxwz-JwRd0upmI0VNdvInbAm2FOQvPo3pS0SEhWfkI4,1947
-otf_api/models/responses/body_composition_list.py,sha256=RTC5bQpmMDUKqFl0nGFExdDxfnbOAGoBLWunjpOym80,12193
-otf_api/models/responses/book_class.py,sha256=bWURKEjLZWPzwu3HNP2zUmHWo7q7h6_z43a9KTST0Ec,15413
-otf_api/models/responses/bookings.py,sha256=XwW6blHpw9imtXRnQJYahUgfrAeOcGZqfYE-oJZ8510,8467
-otf_api/models/responses/cancel_booking.py,sha256=dmC5OP97Dy4qYT0l1KHYIitqSCo6M6Yqa0QztjgG_xQ,3859
-otf_api/models/responses/challenge_tracker_content.py,sha256=KKpSWyyg3viN0vf1Sg2zTMlMZExLe3I6wowmUPWvRCA,1423
-otf_api/models/responses/challenge_tracker_detail.py,sha256=o0y_ETfHmR1QhoOmvd83P6lfMZUPIwPlnS1V_po0dkE,3048
-otf_api/models/responses/classes.py,sha256=VxesbFyfRhohwkjiclqTtMPl8bNc5PJajveTHtDBQ2A,4731
-otf_api/models/responses/enums.py,sha256=Au8XhD-4T8ljiueUykFDc6Qz7kOoTlJ_kiDEx7nLVLM,1191
-otf_api/models/responses/favorite_studios.py,sha256=C5JSyiNijm6HQEBVrV9vPfZexSWQ1IlN0E3Ag0GeP_0,4982
-otf_api/models/responses/latest_agreement.py,sha256=aE8hbWE4Pgguw4Itah7a1SqwOLpJ6t9oODFwLQ8Wzo0,774
-otf_api/models/responses/lifetime_stats.py,sha256=3nWjXJoIcTV_R-Q-3SXo63Uj2xjkFtNXmzj_jPcZPyo,3339
-otf_api/models/responses/member_detail.py,sha256=WG_GjS_7mZQ72d5rgu7e1dc3e4fVaR5HRlxFtbJfct8,6024
-otf_api/models/responses/member_membership.py,sha256=_z301T9DrdQW9vIgnx_LeZmkRhvMVhkxrn_v6DDfCUk,995
-otf_api/models/responses/member_purchases.py,sha256=JoTk3hYjsq4rXogVivZxeFaM-j3gIChmIAGVldOU7rE,6085
-otf_api/models/responses/out_of_studio_workout_history.py,sha256=FwdnmTgFrMtQ8PngsmCv3UroWj3kDnQg6KfGLievoaU,1709
-otf_api/models/responses/performance_summary_detail.py,sha256=H5yWxGShR4uiXvY2OaniENburTGM7DKQjN7gvF3MG6g,1585
-otf_api/models/responses/performance_summary_list.py,sha256=R__tsXGz5tVX5gfoRoVUNK4UP2pXRoK5jdSyHABsDXs,1234
-otf_api/models/responses/studio_detail.py,sha256=CJBCsi4SMs_W5nrWE4hfCs1ugJ5t7GrH80hTv7Ie3eg,5007
-otf_api/models/responses/studio_services.py,sha256=mFDClPtU0HCk5fb19gjGKpt2F8n8kto7sj1pE_l4RdQ,1836
-otf_api/models/responses/telemetry.py,sha256=8dl8FKLeyb6jtqsZT7XD4JzXBMLlami448-Jt0tFbSY,1663
-otf_api/models/responses/telemetry_hr_history.py,sha256=vDcLb4wTHVBw8O0mGblUujHfJegkflOCWW-bnTXNCI0,763
-otf_api/models/responses/telemetry_max_hr.py,sha256=xKxH0fIlOqFyZv8UW98XsxF-GMoIs9gnCTAbu88ZQtg,266
-otf_api/models/responses/total_classes.py,sha256=WrKkWbq0eK8J0RC4qhZ5kmXnv_ZTDbyzsoRm7XKGlss,288
-otf_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-otf_api-0.6.0.dist-info/AUTHORS.md,sha256=FcNWMxpe8KDuTq4Qau0SUXsabQwGs9TGnMp1WkXRnj8,123
-otf_api-0.6.0.dist-info/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
-otf_api-0.6.0.dist-info/METADATA,sha256=lzG11-AQbcrEr5whF8QiBWSeJljHCG3V2OL_I1hDl6M,2031
-otf_api-0.6.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-otf_api-0.6.0.dist-info/RECORD,,