otf-api 0.10.0__tar.gz → 0.10.1__tar.gz

{otf_api-0.10.0 → otf_api-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: otf-api
-Version: 0.10.0
+Version: 0.10.1
 Summary: Python OrangeTheory Fitness API Client
 License: MIT
 Author: Jessica Smith

{otf_api-0.10.0 → otf_api-0.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "otf-api"
-version = "0.10.0"
+version = "0.10.1"
 description = "Python OrangeTheory Fitness API Client"
 authors = ["Jessica Smith <j.smith.git1@gmail.com>"]
 license = "MIT"

{otf_api-0.10.0 → otf_api-0.10.1}/src/otf_api/__init__.py

@@ -4,7 +4,7 @@ from otf_api.api import Otf
 from otf_api import models
 from otf_api.auth import OtfUser
 
-__version__ = "0.10.0"
+__version__ = "0.10.1"
 
 
 __all__ = ["Otf", "OtfUser", "models"]

{otf_api-0.10.0 → otf_api-0.10.1}/src/otf_api/api.py

@@ -1,7 +1,6 @@
 import atexit
 import contextlib
 import functools
-import warnings
 from concurrent.futures import ThreadPoolExecutor
 from copy import deepcopy
 from datetime import date, datetime, timedelta
@@ -177,9 +176,10 @@ class Otf:
         """Retrieve raw member membership details."""
         return self._default_request("GET", f"/member/members/{self.member_uuid}/memberships")
 
-    def _get_performance_summaries_raw(self) -> dict:
+    def _get_performance_summaries_raw(self, limit: int | None = None) -> dict:
         """Retrieve raw performance summaries data."""
-        return self._performance_summary_request("GET", "/v1/performance-summaries")
+        params = {"limit": limit} if limit else {}
+        return self._performance_summary_request("GET", "/v1/performance-summaries", params=params)
 
     def _get_performance_summary_raw(self, performance_summary_id: str) -> dict:
         """Retrieve raw performance summary data."""
@@ -321,14 +321,16 @@ class Otf:
             },
         )
 
-    def _rate_class_raw(self, class_uuid: str, class_history_uuid: str, class_rating: int, coach_rating: int) -> dict:
+    def _rate_class_raw(
+        self, class_uuid: str, performance_summary_id: str, class_rating: int, coach_rating: int
+    ) -> dict:
         """Retrieve raw response from rating a class and coach."""
         return self._default_request(
             "POST",
             "/mobile/v1/members/classes/ratings",
             json={
                 "classUUId": class_uuid,
-                "otBeatClassHistoryUUId": class_history_uuid,
+                "otBeatClassHistoryUUId": performance_summary_id,
                 "classRating": class_rating,
                 "coachRating": coach_rating,
             },
@@ -919,6 +921,8 @@ class Otf:
         """Get detailed information about a specific studio. If no studio UUID is provided, it will default to the
         user's home studio.
 
+        If the studio is not found, it will return a StudioDetail object with default values.
+
         Args:
             studio_uuid (str, optional): The studio UUID to get detailed information about.
 
@@ -926,7 +930,11 @@ class Otf:
             StudioDetail: Detailed information about the studio.
         """
         studio_uuid = studio_uuid or self.home_studio_uuid
-        res = self._get_studio_detail_raw(studio_uuid)
+
+        try:
+            res = self._get_studio_detail_raw(studio_uuid)
+        except exc.ResourceNotFoundError:
+            return models.StudioDetail(studioUUId=studio_uuid, studioName="Studio Not Found", studioStatus="Unknown")
 
         return models.StudioDetail(**res["data"])
 
@@ -1103,9 +1111,12 @@ class Otf:
         return models.FitnessBenchmark(**data["Dto"][0])
 
     @cached(cache=TTLCache(maxsize=1024, ttl=600))
-    def get_performance_summaries_dict(self) -> dict[str, models.PerformanceSummary]:
+    def get_performance_summaries_dict(self, limit: int | None = None) -> dict[str, models.PerformanceSummary]:
         """Get a dictionary of performance summaries for the authenticated user.
 
+        Args:
+            limit (int | None): The maximum number of entries to return. Default is None.
+
         Returns:
             dict[str, PerformanceSummary]: A dictionary of performance summaries, keyed by class history UUID.
 
@@ -1115,7 +1126,7 @@ class Otf:
 
         """
 
-        items = self._get_performance_summaries_raw()["items"]
+        items = self._get_performance_summaries_raw(limit=limit)["items"]
 
         distinct_studio_ids = set([rec["class"]["studio"]["id"] for rec in items])
         perf_summary_ids = set([rec["id"] for rec in items])
@@ -1133,7 +1144,7 @@ class Otf:
             item["detail"] = perf_summary_dict[item["id"]]
 
         entries = [models.PerformanceSummary(**item) for item in items]
-        entries_dict = {entry.class_history_uuid: entry for entry in entries}
+        entries_dict = {entry.performance_summary_id: entry for entry in entries}
 
         return entries_dict
 
@@ -1141,7 +1152,7 @@ class Otf:
         """Get a list of all performance summaries for the authenticated user.
 
         Args:
-            limit (int | None): The maximum number of entries to return. Default is None. Deprecated.
+            limit (int | None): The maximum number of entries to return. Default is None.
 
         Returns:
             list[PerformanceSummary]: A list of performance summaries.
@@ -1152,26 +1163,33 @@ class Otf:
 
         """
 
-        if limit:
-            warnings.warn("Limit is deprecated and will be removed in a future version.", DeprecationWarning)
-
-        records = list(self.get_performance_summaries_dict().values())
+        records = list(self.get_performance_summaries_dict(limit=limit).values())
 
         sorted_records = sorted(records, key=lambda x: x.otf_class.starts_at, reverse=True)
 
         return sorted_records
 
-    def get_performance_summary(self, performance_summary_id: str) -> models.PerformanceSummary:
+    def get_performance_summary(
+        self, performance_summary_id: str, limit: int | None = None
+    ) -> models.PerformanceSummary:
         """Get performance summary for a given workout.
 
+        Note: Due to the way the OTF API is set up, we have to call both the list and the get endpoints. By
+        default this will call the list endpoint with no limit, in order to ensure that the performance summary
+        is returned if it exists. This could result in a lot of requests, so you also have the option to provide
+        a limit to only fetch a certain number of performance summaries.
+
         Args:
             performance_summary_id (str): The ID of the performance summary to retrieve.
 
         Returns:
             PerformanceSummary: The performance summary.
+
+        Raises:
+            ResourceNotFoundError: If the performance_summary_id is not in the list of performance summaries.
         """
 
-        perf_summary = self.get_performance_summaries_dict().get(performance_summary_id)
+        perf_summary = self.get_performance_summaries_dict(limit=limit).get(performance_summary_id)
 
         if perf_summary is None:
             raise exc.ResourceNotFoundError(f"Performance summary {performance_summary_id} not found")
@@ -1180,7 +1198,7 @@ class Otf:
 
     @functools.lru_cache(maxsize=1024)
     def _get_performancy_summary_detail(self, performance_summary_id: str) -> dict[str, Any]:
-        """Get the details for a performance summary.
+        """Get the details for a performance summary. Generally should not be called directly. This
 
         Args:
             performance_summary_id (str): The performance summary ID.
@@ -1350,7 +1368,7 @@ class Otf:
     def _rate_class(
         self,
         class_uuid: str,
-        class_history_uuid: str,
+        performance_summary_id: str,
         class_rating: Literal[0, 1, 2, 3],
         coach_rating: Literal[0, 1, 2, 3],
     ) -> models.PerformanceSummary:
@@ -1363,7 +1381,7 @@ class Otf:
 
         Args:
             class_uuid (str): The class UUID.
-            class_history_uuid (str): The performance summary ID.
+            performance_summary_id (str): The performance summary ID.
             class_rating (int): The class rating. Must be 0, 1, 2, or 3.
             coach_rating (int): The coach rating. Must be 0, 1, 2, or 3.
 
@@ -1390,10 +1408,10 @@ class Otf:
         body_coach_rating = COACH_RATING_MAP[coach_rating]
 
         try:
-            self._rate_class_raw(class_uuid, class_history_uuid, body_class_rating, body_coach_rating)
+            self._rate_class_raw(class_uuid, performance_summary_id, body_class_rating, body_coach_rating)
         except exc.OtfRequestError as e:
             if e.response.status_code == 403:
-                raise exc.AlreadyRatedError(f"Performance summary {class_history_uuid} is already rated.") from None
+                raise exc.AlreadyRatedError(f"Performance summary {performance_summary_id} is already rated.") from None
             raise
 
         # we have to clear the cache after rating a class, otherwise we will get back the same data
@@ -1403,7 +1421,7 @@ class Otf:
         # NOTE: the individual perf summary endpoint does not have rating data, so it's cache is not cleared
         self.get_performance_summaries_dict.cache_clear()
 
-        return self.get_performance_summary(class_history_uuid)
+        return self.get_performance_summary(performance_summary_id)
 
     def rate_class_from_performance_summary(
         self,
@@ -1429,18 +1447,20 @@ class Otf:
         """
 
         if perf_summary.is_rated:
-            raise exc.AlreadyRatedError(f"Performance summary {perf_summary.class_history_uuid} is already rated.")
+            raise exc.AlreadyRatedError(f"Performance summary {perf_summary.performance_summary_id} is already rated.")
 
         if not perf_summary.ratable:
-            raise exc.ClassNotRatableError(f"Performance summary {perf_summary.class_history_uuid} is not rateable.")
+            raise exc.ClassNotRatableError(
+                f"Performance summary {perf_summary.performance_summary_id} is not rateable."
+            )
 
         if not perf_summary.otf_class or not perf_summary.otf_class.class_uuid:
             raise ValueError(
-                f"Performance summary {perf_summary.class_history_uuid} does not have an associated class."
+                f"Performance summary {perf_summary.performance_summary_id} does not have an associated class."
             )
 
         return self._rate_class(
-            perf_summary.otf_class.class_uuid, perf_summary.class_history_uuid, class_rating, coach_rating
+            perf_summary.otf_class.class_uuid, perf_summary.performance_summary_id, class_rating, coach_rating
         )
 
     # the below do not return any data for me, so I can't test them

{otf_api-0.10.0 → otf_api-0.10.1}/src/otf_api/models/enums.py

@@ -8,6 +8,7 @@ class StudioStatus(StrEnum):
     COMING_SOON = "Coming Soon"
     TEMP_CLOSED = "Temporarily Closed"
     PERM_CLOSED = "Permanently Closed"
+    UNKNOWN = "Unknown"
 
 
 class BookingStatus(StrEnum):

{otf_api-0.10.0 → otf_api-0.10.1}/src/otf_api/models/performance_summary.py

@@ -105,7 +105,8 @@ class PerformanceSummary(OtfItemBase):
 
     """
 
-    class_history_uuid: str = Field(..., alias="id")
+    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")
     ratable: bool | None = None
     otf_class: Class | None = Field(None, alias="class")
     coach: str | None = Field(None, alias=AliasPath("class", "coach", "first_name"))

{otf_api-0.10.0 → otf_api-0.10.1}/src/otf_api/models/studio_detail.py

@@ -9,8 +9,8 @@ from otf_api.models.mixins import AddressMixin
 
 class StudioLocation(AddressMixin):
     phone_number: str | None = Field(None, alias=AliasChoices("phone", "phoneNumber"))
-    latitude: float = Field(..., alias=AliasChoices("latitude"))
-    longitude: float = Field(..., alias=AliasChoices("longitude"))
+    latitude: float | None = Field(None, alias=AliasChoices("latitude"))
+    longitude: float | None = Field(None, alias=AliasChoices("longitude"))
 
     physical_region: str | None = Field(None, alias="physicalRegion", exclude=True, repr=False)
     physical_country_id: int | None = Field(None, alias="physicalCountryId", exclude=True, repr=False)
@@ -27,7 +27,7 @@ class StudioDetail(OtfItemBase):
         exclude=True,
         repr=False,
     )
-    location: StudioLocation = Field(..., alias="studioLocation")
+    location: StudioLocation = Field(..., alias="studioLocation", default_factory=StudioLocation)
     name: str | None = Field(None, alias="studioName")
     status: StudioStatus | None = Field(
         None, alias="studioStatus", description="Active, Temporarily Closed, Coming Soon"

{otf_api-0.10.0 → otf_api-0.10.1}/src/otf_api/models/telemetry.py

@@ -49,7 +49,10 @@ class TelemetryItem(OtfItemBase):
 
 class Telemetry(OtfItemBase):
     member_uuid: str = Field(..., alias="memberUuid")
-    class_history_uuid: str = Field(..., alias="classHistoryUuid")
+    performance_summary_id: str = Field(
+        ..., alias="classHistoryUuid", description="The ID of the performance summary this telemetry item belongs to."
+    )
+    class_history_uuid: str = Field(..., alias="classHistoryUuid", description="The same as performance_summary_id.")
     class_start_time: datetime | None = Field(None, alias="classStartTime")
     max_hr: int | None = Field(None, alias="maxHr")
     zones: Zones