otf-api 0.12.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

otf_api/models/{performance_summary.py → workouts/performance_summary.py}

@@ -22,15 +22,27 @@ class HeartRate(OtfItemBase):
 
 
 class PerformanceMetric(OtfItemBase):
-    display_value: time | float
+    display_value: time | float | None
     display_unit: str
     metric_value: float
 
+    def __str__(self) -> str:
+        """Return a string representation of the PerformanceMetric."""
+        return f"{self.display_value} {self.display_unit}"
+
     @field_validator("display_value", mode="before")
     @classmethod
-    def convert_to_time_format(cls, value) -> time | float:
+    def convert_to_time_format(cls, value: str | None | float | int) -> time | float | None:
+        """Convert display_value to a time object if it is in the format of HH:MM:SS or MM:SS.
+
+        Args:
+            value (str | None | float | int): The value to convert.
+
+        Returns:
+            time | float: The converted value, or the original value if it is not in the expected format.
+        """
         if not value:
-            return value
+            return None
 
         if isinstance(value, float | int):
             return value
@@ -73,8 +85,10 @@ class PerformanceSummary(OtfItemBase):
     You likely want to use the `Workout` model and `get_workouts` method instead.
     """
 
-    performance_summary_id: str = Field(..., alias="id", description="Unique identifier for this performance summary")
-    class_history_uuid: str = Field(..., alias="id", description="Same as performance_summary_id")
+    performance_summary_id: str = Field(
+        ..., validation_alias="id", description="Unique identifier for this performance summary"
+    )
+    class_history_uuid: str = Field(..., validation_alias="id", description="Same as performance_summary_id")
     ratable: bool | None = None
 
     calories_burned: int | None = Field(None, validation_alias=AliasPath("details", "calories_burned"))

otf_api/models/workouts/telemetry.py

@@ -0,0 +1,88 @@
+from datetime import datetime, timedelta
+from typing import Any
+
+from pydantic import AliasPath, Field, field_serializer
+
+from otf_api.models.base import OtfItemBase
+
+
+class Zone(OtfItemBase):
+    start_bpm: int = Field(..., validation_alias="startBpm")
+    end_bpm: int = Field(..., validation_alias="endBpm")
+
+
+class Zones(OtfItemBase):
+    gray: Zone
+    blue: Zone
+    green: Zone
+    orange: Zone
+    red: Zone
+
+
+class TreadData(OtfItemBase):
+    tread_speed: float = Field(..., validation_alias="treadSpeed")
+    tread_incline: float = Field(..., validation_alias="treadIncline")
+    agg_tread_distance: int = Field(..., validation_alias="aggTreadDistance")
+
+
+class RowData(OtfItemBase):
+    row_speed: float = Field(..., validation_alias="rowSpeed")
+    row_pps: float = Field(..., validation_alias="rowPps")
+    row_spm: float = Field(..., validation_alias="rowSpm")
+    agg_row_distance: int = Field(..., validation_alias="aggRowDistance")
+    row_pace: int = Field(..., validation_alias="rowPace")
+
+
+class TelemetryItem(OtfItemBase):
+    relative_timestamp: int = Field(..., validation_alias="relativeTimestamp")
+    hr: int | None = None
+    agg_splats: int = Field(..., validation_alias="aggSplats")
+    agg_calories: int = Field(..., validation_alias="aggCalories")
+    timestamp: datetime | None = Field(
+        None,
+        init_var=False,
+        description="The timestamp of the telemetry item, calculated from the class start time and relative timestamp.",
+    )
+    tread_data: TreadData | None = Field(None, validation_alias="treadData")
+    row_data: RowData | None = Field(None, validation_alias="rowData")
+
+
+class Telemetry(OtfItemBase):
+    member_uuid: str = Field(..., validation_alias="memberUuid")
+    performance_summary_id: str = Field(
+        ...,
+        validation_alias="classHistoryUuid",
+        description="The ID of the performance summary this telemetry item belongs to.",
+    )
+    class_history_uuid: str = Field(
+        ..., validation_alias="classHistoryUuid", description="The same as performance_summary_id."
+    )
+    class_start_time: datetime | None = Field(None, validation_alias="classStartTime")
+    max_hr: int | None = Field(None, validation_alias="maxHr")
+    zones: Zones
+    window_size: int | None = Field(None, validation_alias="windowSize")
+    telemetry: list[TelemetryItem] = Field(default_factory=list)
+
+    def __init__(self, **data: dict[str, Any]):
+        super().__init__(**data)
+        for telem in self.telemetry:
+            if self.class_start_time is None:
+                continue
+
+            telem.timestamp = self.class_start_time + timedelta(seconds=telem.relative_timestamp)
+
+    @field_serializer("telemetry", when_used="json")
+    def reduce_telemetry_list(self, value: list[TelemetryItem]) -> list[TelemetryItem]:
+        """Reduces the telemetry list to only include the first 10 items."""
+        if len(value) > 10:
+            return value[:5] + value[-5:]
+        return value
+
+
+class TelemetryHistoryItem(OtfItemBase):
+    max_hr_type: str | None = Field(None, validation_alias=AliasPath("maxHr", "type"))
+    max_hr_value: int | None = Field(None, validation_alias=AliasPath("maxHr", "value"))
+    zones: Zones | None = None
+    change_from_previous: int | None = Field(None, validation_alias="changeFromPrevious")
+    change_bucket: str | None = Field(None, validation_alias="changeBucket")
+    assigned_at: datetime | None = Field(None, validation_alias="assignedAt")

otf_api/models/{workout.py → workouts/workout.py}

@@ -1,21 +1,15 @@
+from typing import Any, Literal
+
 from pydantic import AliasPath, Field
 
 from otf_api.models.base import OtfItemBase
-from otf_api.models.bookings_v2 import (
-    BookingV2,
-    BookingV2Class,
-    BookingV2Studio,
-    BookingV2Workout,
-    Rating,
-    ZoneTimeMinutes,
-)
-from otf_api.models.performance_summary import HeartRate, Rower, Treadmill
-from otf_api.models.telemetry import Telemetry
-
-
-class Workout(OtfItemBase):
-    """Represents a workout - this combines the performance summary, data from the new bookings endpoint, and
-    telemetry data.
+from otf_api.models.bookings import BookingV2, BookingV2Class, BookingV2Studio, BookingV2Workout, Rating
+from otf_api.models.mixins import ApiMixin
+from otf_api.models.workouts import HeartRate, Rower, Telemetry, Treadmill, ZoneTimeMinutes
+
+
+class Workout(ApiMixin, OtfItemBase):
+    """Represents a workout - combines the performance summary, data from the new bookings endpoint, and telemetry data.
 
     The final product contains all the performance summary data, the detailed data over time, as well as the class,
     coach, studio, and rating data from the new endpoint.
@@ -23,8 +17,10 @@ class Workout(OtfItemBase):
     This should match the data that is shown in the OTF app after a workout.
     """
 
-    performance_summary_id: str = Field(..., alias="id", description="Unique identifier for this performance summary")
-    class_history_uuid: str = Field(..., alias="id", description="Same as performance_summary_id")
+    performance_summary_id: str = Field(
+        ..., validation_alias="id", description="Unique identifier for this performance summary"
+    )
+    class_history_uuid: str = Field(..., validation_alias="id", description="Same as performance_summary_id")
     booking_id: str = Field(..., description="The booking id for the new bookings endpoint.")
     class_uuid: str | None = Field(
         None, description="Used by the ratings endpoint - seems to fall off after a few months"
@@ -72,10 +68,28 @@ class Workout(OtfItemBase):
         data["class_rating"] = v2_booking.class_rating
         data["coach_rating"] = v2_booking.coach_rating
 
-        telemetry = data.get("telemetry")
-        if telemetry and isinstance(telemetry, Telemetry):
+        telemetry: dict[str, Any] | None = data.get("telemetry")
+        if telemetry and "maxHr" in telemetry:
             # max_hr seems to be left out of the heart rate data - it has peak_hr but they do not match
             # so if we have telemetry data, we can get the max_hr from there
-            data["details"]["heart_rate"]["max_hr"] = telemetry.max_hr
+            data["details"]["heart_rate"]["max_hr"] = telemetry["maxHr"]
 
         super().__init__(**data)
+
+    def rate(self, class_rating: Literal[0, 1, 2, 3], coach_rating: Literal[0, 1, 2, 3]) -> None:
+        """Rate the class and coach for this workout.
+
+        The class rating must be 0, 1, 2, or 3. 0 is the same as dismissing the prompt to rate the class/coach. 1 - 3\
+            is a range from bad to good.
+
+        Args:
+            class_rating (Literal[0, 1, 2, 3]): Rating for the class.
+            coach_rating (Literal[0, 1, 2, 3]): Rating for the coach.
+
+        Raises:
+            ValueError: If the API instance is not set.
+            AlreadyRatedError: If the performance summary is already rated.
+            ClassNotRatableError: If the performance summary is not rateable.
+        """
+        self.raise_if_api_not_set()
+        self._api.workouts.rate_class_from_workout(self, class_rating=class_rating, coach_rating=coach_rating)

{otf_api-0.12.0.dist-info → otf_api-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otf-api
-Version: 0.12.0
+Version: 0.13.0
 Summary: Python OrangeTheory Fitness API Client
 Author-email: Jessica Smith <j.smith.git1@gmail.com>
 License-Expression: MIT
@@ -9,7 +9,6 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Operating System :: OS Independent
@@ -27,6 +26,9 @@ Requires-Dist: yarl<2,>=1.18.3
 Requires-Dist: tenacity<10,>=9.0.0
 Requires-Dist: cachetools>=5.5.0
 Requires-Dist: pendulum>=3.1.0
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: platformdirs>=4.3.6
+Requires-Dist: packaging>=24.2
 Dynamic: license-file
 
 Simple API client for interacting with the OrangeTheory Fitness APIs.

otf_api-0.13.0.dist-info/RECORD

@@ -0,0 +1,59 @@
+otf_api/__init__.py,sha256=mpjME4x_GP5hUzbQ99qMPuZ4pzbQNrYXLAXqnGNsXcw,1150
+otf_api/cache.py,sha256=m4xUBhaS0MkcZypon1jjfhJzZPRQBE5Fto4_RMReXZ0,4311
+otf_api/exceptions.py,sha256=b6ZdH1dtYyUfXSupdVGGni6d66qqhzD0SGzyuty89gM,2174
+otf_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otf_api/api/__init__.py,sha256=YC6bwYiAN6BSE7sqbxr2l34vwSdZPMGDv3wwPIQ_S3o,51
+otf_api/api/_compat.py,sha256=vWMC6kC3tK9qoXwnU5AgbQie-dhYAkkUI-hmq_4nf7Q,3512
+otf_api/api/api.py,sha256=yda8RObOMd_lBWbqlAAUZ3dTwGhdEYsfGQJDiphp6Eo,2633
+otf_api/api/client.py,sha256=o533H-nYweRcosBEYmm3U-7ivkpGDF7jElM9iIhK7E8,8157
+otf_api/api/utils.py,sha256=mNDUrz6d8b8KqTaUr5fGGGejy6bq9HHLs9LS8ibbfW4,9926
+otf_api/api/bookings/__init__.py,sha256=ocHSZXV4nnkZhjpjBX76iKHCQ21_ZL5hV4YKgUR0Wwg,62
+otf_api/api/bookings/booking_api.py,sha256=s4GWT1MYUY0-EjXucj_8rcNfRP6o-sFGfVsmY3RJMdM,22087
+otf_api/api/bookings/booking_client.py,sha256=qYaEomexGWP2N_WdWePMN7BR8aIKEpO71g5J0KaVfAc,4244
+otf_api/api/members/__init__.py,sha256=6mkeMiATRsNQTYQ37P7k6SWf9RZ9T5QY9-_r1sS1-vY,59
+otf_api/api/members/member_api.py,sha256=bpSnUWrLbrqkIcwhzaPonkWTa9-gLPdadzE4ec_meT0,7224
+otf_api/api/members/member_client.py,sha256=d6v6vexmtiedw1-lXLMobbN8tTmRT-zHq7VzdJb5wDE,4528
+otf_api/api/studios/__init__.py,sha256=vPir509hQOJL7uJ4yBCOHgooXVnXs6N5RlWs1tN54Uk,59
+otf_api/api/studios/studio_api.py,sha256=qggdaTGeYtrE1q5oV8ozCqAC5Xv6DtwVG5dHzSB1q74,6781
+otf_api/api/studios/studio_client.py,sha256=KWc4CF-2387WDUFYpMtIUm3KyPj1JdelCn7RH9L1FBI,4707
+otf_api/api/workouts/__init__.py,sha256=GPb2cEsAxoaiJIP8Finrk9x9vUeL9NXA9iz2eya9HYk,62
+otf_api/api/workouts/workout_api.py,sha256=h65nEt2-2mYV33tiVkv2N6L7NoEJ_naViw-IrMnEn8E,13207
+otf_api/api/workouts/workout_client.py,sha256=MvEWbhPXywpQMSdsBSGCYBIR65TJjdqgb7T0Bc8H8D0,6762
+otf_api/auth/__init__.py,sha256=uTvFTNQVvfogTN_-4D3bRSundAf2enUJ5ji6PwO0xm8,104
+otf_api/auth/auth.py,sha256=67-RXDla3rVm5vmlyPEOqPOF5kecJiEznVmq0gSz3M0,16448
+otf_api/auth/user.py,sha256=OChRG0EhZ63vEtT_Sg3NmXWmOD1vZcILuHhRXlwaG0I,2156
+otf_api/auth/utils.py,sha256=YBxqg2h59u4V1ij5kgqJDyKh0gtgOlXrSZdpAKSdelY,3954
+otf_api/models/__init__.py,sha256=P0IjxRUPIfzUI-e3VDMpipJeWr6BlypWAED2ovnZw-w,1545
+otf_api/models/base.py,sha256=KJlIxl_sRj6f-g5vKYPw4yV6fGDk-fwZ93EO0JGPYMw,202
+otf_api/models/mixins.py,sha256=mY9ufoi3QJM5H7KMU9q7grgYuZp85xLs8ie2aLikvi8,4164
+otf_api/models/bookings/__init__.py,sha256=-EtaVW9qF5dmWvSlkq693vkxc3bX6d7dWOgcnNNfpV4,642
+otf_api/models/bookings/bookings.py,sha256=YlocSxdOEECxcCsVkEYAXHFE3EmMTUBxXgSFFxskaLk,5681
+otf_api/models/bookings/bookings_v2.py,sha256=Jd9zh4E3AEWUyxLTISq2j2I_firKCfV5IQzNdkc7iK4,7965
+otf_api/models/bookings/classes.py,sha256=k5cOdMCdDyyXgwBnMrLV9gV_CYE02L8rKewTz8Vv7mg,5068
+otf_api/models/bookings/enums.py,sha256=z9nSciWjvnpKDTHwj496aTKGgREvAeu-h6RKBAf-Tm0,3140
+otf_api/models/bookings/filters.py,sha256=quorUTo9_PR03JMv2m2qhXKhGtb_URLOu92Lj2Y6IMQ,4866
+otf_api/models/bookings/ratings.py,sha256=QHUQQoDmT1sLVil1QJsqP1QKFWfSypg7B2RzyQeCMng,914
+otf_api/models/members/__init__.py,sha256=umzYnnZvRDcX7qVq3t5IRjxxtmTe4F75JjZJm5923gA,199
+otf_api/models/members/member_detail.py,sha256=ACcfomS2hz7i-8521jUBRGYO3oTwpMMrIP9wcTHFOgY,8039
+otf_api/models/members/member_membership.py,sha256=pz-lHD6T60-rh1StRlCJd0L-g3PPkiFIeRVv1P-ebjY,1481
+otf_api/models/members/member_purchases.py,sha256=oEHMRJCFeU8A39fcY0RDDUimedP4aLjh4Ueoz5te0eo,1775
+otf_api/models/members/notifications.py,sha256=7RONios8H1WnzRKuy3E7s5j6MXSwKk60b5NkjB6Biok,910
+otf_api/models/studios/__init__.py,sha256=2mMRnwFdlnE6Mubcrh7K35x86jEINGnSPa7oYHETN8Q,210
+otf_api/models/studios/enums.py,sha256=I5B4iyHUvcBfn0C3pMwnriAZxx8-fhupDlyrD_jSZa8,258
+otf_api/models/studios/studio_detail.py,sha256=cinktnXq3AH0BnSR1W4kXrIkDw8bg0IOXO4_sS1FCHc,4979
+otf_api/models/studios/studio_services.py,sha256=Y7INy_9-UhIM1g5EQjmhlJtdJouSvYIvG8GIa4H3UpU,1835
+otf_api/models/workouts/__init__.py,sha256=picQOBsx0JhkgQlZwQq_vQShC5ZepJWpvSTO3N1K_RA,1003
+otf_api/models/workouts/body_composition_list.py,sha256=E5xDqP647QEC8seKBBDeFaTod-mL4alXn-tP83RtvIg,14930
+otf_api/models/workouts/challenge_tracker_content.py,sha256=kP57mYsLiDfuSVRJswESi-XXCL7BBQfULEXEiOM78SI,2459
+otf_api/models/workouts/challenge_tracker_detail.py,sha256=v-1WbOnBtuUyxllxlzUSuhtcBr3hV8PldI_6-SZCPQI,4920
+otf_api/models/workouts/enums.py,sha256=El_H3l6XLxO27Xo23YheR6LPvIjfTUaeK0rBpQvRHpc,1540
+otf_api/models/workouts/lifetime_stats.py,sha256=WBDqdcJ4Bz2YXg1WOijeJgs7LKcix_JgZ5lkwsOpGiI,3819
+otf_api/models/workouts/out_of_studio_workout_history.py,sha256=-BKp-MnIp_5-U2KWy6nv58H6flgcbdOGsSbz5cHq20w,1945
+otf_api/models/workouts/performance_summary.py,sha256=R1p-g1L4XWWEiBYaGtX5JFvoS3Z6bzQrsPIfTQHDqyM,3464
+otf_api/models/workouts/telemetry.py,sha256=rKsmLbsOVUxUXH439zxxIEWYGTohKNemqrtMamAl5cA,3465
+otf_api/models/workouts/workout.py,sha256=_KIR9fLI4LgUlS02Q5SNauHd4aOqJI9H4uaFKf-xJOU,4580
+otf_api-0.13.0.dist-info/licenses/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
+otf_api-0.13.0.dist-info/METADATA,sha256=-x6Y4z5eG5ECRWfbS_jmbFr3oo6eNrKdrNMeDkMniuM,2162
+otf_api-0.13.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+otf_api-0.13.0.dist-info/top_level.txt,sha256=KAhYg1X2YG0LkTuVRhUV1I_AReNZUVNdEan7cp0pEE4,8
+otf_api-0.13.0.dist-info/RECORD,,

{otf_api-0.12.0.dist-info → otf_api-0.13.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any