otf-api 0.11.1__py3-none-any.whl → 0.12.1__py3-none-any.whl

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.11.1"
+__version__ = "0.12.1"
 
 
 __all__ = ["Otf", "OtfUser", "models"]

otf_api/api.py

@@ -1,7 +1,7 @@
 import atexit
 import contextlib
 from concurrent.futures import ThreadPoolExecutor
-from datetime import date, datetime, timedelta
+from datetime import date, datetime, time, timedelta
 from functools import partial
 from json import JSONDecodeError
 from logging import getLogger
@@ -437,16 +437,16 @@ class Otf:
         """Get bookings from the new endpoint with no date filters."""
         start_date = pendulum.datetime(1970, 1, 1)
         end_date = pendulum.today().start_of("day").add(days=45)
-        return self.get_bookings_new(start_date, end_date, exclude_canceled=False)
+        return self.get_bookings_new(start_date, end_date, exclude_cancelled=False)
 
     def _get_app_config_raw(self) -> dict[str, Any]:
         return self._default_request("GET", "/member/app-configurations", headers={"SIGV4AUTH_REQUIRED": "true"})
 
     def get_bookings_new(
         self,
-        start_dtme: datetime | str | None = None,
-        end_dtme: datetime | str | None = None,
-        exclude_canceled: bool = True,
+        start_date: datetime | date | str | None = None,
+        end_date: datetime | date | str | None = None,
+        exclude_cancelled: bool = True,
     ) -> list[models.BookingV2]:
         """Get the bookings for the user. If no dates are provided, it will return all bookings
         between today and 45 days from now.
@@ -458,9 +458,9 @@ class Otf:
         new class, which is normally transparent to the user.
 
         Args:
-            start_dtme (datetime | str | None): The start date for the bookings. Default is None.
-            end_dtme (datetime | str | None): The end date for the bookings. Default is None.
-            exclude_canceled (bool): Whether to exclude canceled bookings. Default is True.
+            start_dtme (datetime | date | str | None): The start date for the bookings. Default is None.
+            end_dtme (datetime | date | str | None): The end date for the bookings. Default is None.
+            exclude_cancelled (bool): Whether to exclude canceled bookings. Default is True.
         Returns:
             list[BookingV2]: The bookings for the user.
         """
@@ -468,16 +468,16 @@ class Otf:
         expand = True  # this doesn't seem to have an effect? so leaving it out of the argument list
 
         # leaving the parameter as `exclude_canceled` for backwards compatibility
-        include_canceled = not exclude_canceled
+        include_canceled = not exclude_cancelled
 
-        end_dtme = ensure_datetime(end_dtme)
-        start_dtme = ensure_datetime(start_dtme)
+        end_date = ensure_datetime(end_date, time(23, 59, 59))
+        start_date = ensure_datetime(start_date)
 
-        end_dtme = end_dtme or pendulum.today().start_of("day").add(days=45)
-        start_dtme = start_dtme or pendulum.datetime(1970, 1, 1).start_of("day")
+        end_date = end_date or pendulum.today().start_of("day").add(days=45)
+        start_date = start_date or pendulum.datetime(1970, 1, 1).start_of("day")
 
         bookings_resp = self._get_bookings_new_raw(
-            ends_before=end_dtme, starts_after=start_dtme, include_canceled=include_canceled, expand=expand
+            ends_before=end_date, starts_after=start_date, include_canceled=include_canceled, expand=expand
         )
 
         return [models.BookingV2(**b) for b in bookings_resp["items"]]
@@ -1557,7 +1557,7 @@ class Otf:
         start_dtme = pendulum.datetime(start_date.year, start_date.month, start_date.day, 0, 0, 0)
         end_dtme = pendulum.datetime(end_date.year, end_date.month, end_date.day, 23, 59, 59)
 
-        bookings = self.get_bookings_new(start_dtme, end_dtme, exclude_canceled=False)
+        bookings = self.get_bookings_new(start_dtme, end_dtme, exclude_cancelled=False)
         bookings_dict = {b.workout.id: b for b in bookings if b.workout}
 
         perf_summaries_dict = self._get_perf_summaries_threaded(list(bookings_dict.keys()))

otf_api/models/bookings.py

@@ -36,6 +36,11 @@ class OtfClass(OtfItemBase):
     program_name: str | None = Field(None, alias="programName", exclude=True, repr=False)
     virtual_class: bool | None = Field(None, alias="virtualClass", exclude=True, repr=False)
 
+    @property
+    def coach_name(self) -> str:
+        """Shortcut to get the coach's name, to be compatible with new BookingV2Class"""
+        return self.coach.first_name or ""
+
     def __str__(self) -> str:
         starts_at_str = self.starts_at.strftime("%a %b %d, %I:%M %p")
         return f"Class: {starts_at_str} {self.name} - {self.coach.first_name}"
@@ -90,6 +95,11 @@ class Booking(OtfItemBase):
         """Shortcut to get the class end time"""
         return self.otf_class.ends_at
 
+    @property
+    def id_value(self) -> str:
+        """Returns the booking_uuid, to be compatible with new BookingV2 model"""
+        return self.booking_uuid
+
     def __str__(self) -> str:
         starts_at_str = self.otf_class.starts_at.strftime("%a %b %d, %I:%M %p")
         class_name = self.otf_class.name

otf_api/models/bookings_v2.py

@@ -72,6 +72,16 @@ class BookingV2Class(OtfItemBase):
     )
     starts_at_utc: datetime | None = Field(None, alias="starts_at", exclude=True, repr=False)
 
+    @property
+    def coach_name(self) -> str:
+        """Shortcut to get the coach's name, to be compatible with old Booking OtfClass model"""
+        return self.coach or ""
+
+    @property
+    def ends_at(self) -> datetime:
+        """Emulates the end time of the class, to be compatible with old Booking OtfClass model"""
+        return get_end_time(self.starts_at, self.class_type)
+
     def __str__(self) -> str:
         starts_at_str = self.starts_at.strftime("%a %b %d, %I:%M %p")
         return f"Class: {starts_at_str} {self.name} - {self.coach}"
@@ -160,7 +170,17 @@ class BookingV2(OtfItemBase):
     @property
     def ends_at(self) -> datetime:
         """Shortcut to get the class end time"""
-        return get_end_time(self.otf_class.starts_at, self.otf_class.class_type)
+        return self.otf_class.ends_at
+
+    @property
+    def cancelled_date(self) -> datetime | None:
+        """Returns the canceled_at value in a backward-compatible way"""
+        return self.canceled_at
+
+    @property
+    def id_value(self) -> str:
+        """Returns the booking_id, to be compatible with old Booking model"""
+        return self.booking_id
 
     def __str__(self) -> str:
         starts_at_str = self.otf_class.starts_at.strftime("%a %b %d, %I:%M %p")

otf_api/utils.py

@@ -1,6 +1,6 @@
 import json
 import typing
-from datetime import date, datetime
+from datetime import date, datetime, time
 from logging import getLogger
 from pathlib import Path
 from typing import Any
@@ -12,6 +12,8 @@ if typing.TYPE_CHECKING:
 
 LOGGER = getLogger(__name__)
 
+MIN_TIME = datetime.min.time()
+
 
 def get_booking_uuid(booking_or_uuid: "str | models.Booking") -> str:
     from otf_api.models.bookings import Booking
@@ -58,7 +60,7 @@ def ensure_list(obj: list | Any | None) -> list:
     return obj
 
 
-def ensure_datetime(date_str: str | datetime | None) -> datetime | None:
+def ensure_datetime(date_str: str | datetime | date | None, combine_with: time = MIN_TIME) -> datetime | None:
     if not date_str:
         return None
 
@@ -69,7 +71,7 @@ def ensure_datetime(date_str: str | datetime | None) -> datetime | None:
         return date_str
 
     if isinstance(date_str, date):
-        return datetime.combine(date_str, datetime.min.time())
+        return datetime.combine(date_str, combine_with)
 
     raise ValueError(f"Expected str or datetime, got {type(date_str)}")
 

{otf_api-0.11.1.dist-info → otf_api-0.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otf-api
-Version: 0.11.1
+Version: 0.12.1
 Summary: Python OrangeTheory Fitness API Client
 Author-email: Jessica Smith <j.smith.git1@gmail.com>
 License-Expression: MIT

{otf_api-0.11.1.dist-info → otf_api-0.12.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
-otf_api/__init__.py,sha256=VlLjNep7gdvPfnIDl1YbY8uY5eRM1vE4XJvNhI4mIB8,205
-otf_api/api.py,sha256=95qIszuc2zjneEk-VhS9e-F5f2EnUs4lHGehL7rU2G4,67511
+otf_api/__init__.py,sha256=Xp0zKth_NrmagVP6LiblO8dgapMBsx2rJ360uaDBa9k,205
+otf_api/api.py,sha256=bDl9HOo_JPsiA_YR0HgkA2IL-4M0RwbpNla6VLYqKQE,67568
 otf_api/exceptions.py,sha256=GISekwF5dPt0Ol0WCU55kE5ODc5VxicNEEhmlguuE0U,1815
 otf_api/filters.py,sha256=fk2bFGi3srjS96qZlaDx-ARZRaj93NUTUdMJ01TX420,3702
 otf_api/logging.py,sha256=PRZpCaJ1F1Xya3L9Efkt3mKS5_QNr3sXjEUERSxYjvE,563
 otf_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-otf_api/utils.py,sha256=TATPgb5-t3nEAqo_iGY2p2PKzJA564alN1skb23OCMQ,4817
+otf_api/utils.py,sha256=zO8J95StaTnt_VmxLrzb8IFtQJfJDqs9ioqTMDrkkRE,4886
 otf_api/auth/__init__.py,sha256=PuhtiZ02GVP8zVSn1O-fhaYm7JM_tq5yUFATk_-8upk,132
 otf_api/auth/auth.py,sha256=5cPELC9Soif5knDDHm55ii1OMEPkJlGUphAdbOEmaRo,13278
 otf_api/auth/user.py,sha256=XlK3nbqJA4fF5UFmw2tt0eAle4QOQd6trnW72QrBsx4,2681
@@ -12,8 +12,8 @@ otf_api/auth/utils.py,sha256=vc2pEyU-3yKdv0mR6r_zSHZyMw92j5UeIN_kzcb6TeE,2909
 otf_api/models/__init__.py,sha256=MSinaMQaBTGscL-YRKJ3axFiItQ1HoH62wC2xdaBMgk,1876
 otf_api/models/base.py,sha256=KJlIxl_sRj6f-g5vKYPw4yV6fGDk-fwZ93EO0JGPYMw,202
 otf_api/models/body_composition_list.py,sha256=jGdR-9ScvIOtULJNB99aYh2INk2ihoHAnTWtbQCIea4,12202
-otf_api/models/bookings.py,sha256=Lj-IHN1k-w4vF-5aIKbsiQ6Uq-I5_ELoPUKXPGkfbgM,4440
-otf_api/models/bookings_v2.py,sha256=9HyXGnDNDmIqmr4r0_3pR1mFtN_Lfp9nP-4bCiwe5QA,5865
+otf_api/models/bookings.py,sha256=fnHZmN2F8fVSWS_tco3IwjO9SJbbxzuIs2WJcCC0gNs,4781
+otf_api/models/bookings_v2.py,sha256=PFSlORNZF45TRvgLwewbVGoiOd3oDG1YGvvFMtXtbpo,6533
 otf_api/models/challenge_tracker_content.py,sha256=5Ucu1n4W15v1rzhoXNvAD9tCSg3JTUiR92HHiDAxRec,2597
 otf_api/models/challenge_tracker_detail.py,sha256=c2Ds7Kv2-VaPtxoXSUTI5zrmU1A1dcSaM1UIolwSVxU,4323
 otf_api/models/classes.py,sha256=aKV6LGEh0YiPxyOaoMD0gaQOSHqs69cYHhP9H_2p_jY,3051
@@ -31,8 +31,8 @@ otf_api/models/studio_detail.py,sha256=2gq0A27NOZGz_PTBvsB-dkzm01nYc9FHmx1NON6xp
 otf_api/models/studio_services.py,sha256=aGLQMQmjGVpI6YxzAl-mcp3Y9cHPXuH9dIqrl6E-78E,1665
 otf_api/models/telemetry.py,sha256=PQ_CbADW5-t-U2iEQJGugNy-c4rD0q76TfyIqeFnTho,3170
 otf_api/models/workout.py,sha256=P3xVTvcYrm_RdU6qi3Xm2BXTxxvhvF0dgoEcODY41AA,3678
-otf_api-0.11.1.dist-info/licenses/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
-otf_api-0.11.1.dist-info/METADATA,sha256=BEppb5v_YlMUirZck7aKOtVkTemE7Uvantq2Gk8_00Y,2145
-otf_api-0.11.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-otf_api-0.11.1.dist-info/top_level.txt,sha256=KAhYg1X2YG0LkTuVRhUV1I_AReNZUVNdEan7cp0pEE4,8
-otf_api-0.11.1.dist-info/RECORD,,
+otf_api-0.12.1.dist-info/licenses/LICENSE,sha256=UaPT9ynYigC3nX8n22_rC37n-qmTRKLFaHrtUwF9ktE,1071
+otf_api-0.12.1.dist-info/METADATA,sha256=p8fnmEMCyWsqvkYuILlZlxblozmyH7ilGPeM5BkT_zE,2145
+otf_api-0.12.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+otf_api-0.12.1.dist-info/top_level.txt,sha256=KAhYg1X2YG0LkTuVRhUV1I_AReNZUVNdEan7cp0pEE4,8
+otf_api-0.12.1.dist-info/RECORD,,