update README with documentation link, fix a few example files

NodeJSmith · Sep 24, 2024 · 6345ed7 · 6345ed7
1 parent 95d3a03
commit 6345ed7
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 Simple API client for interacting with the OrangeTheory Fitness APIs.
 
+Review the [documentation](https://otf-api.readthedocs.io/en/stable/).
+
 
 This library allows access to the OrangeTheory API to retrieve workouts and performance data, class schedules, studio information, and bookings.
 

diff --git a/examples/class_bookings_examples.py b/examples/class_bookings_examples.py
@@ -1,10 +1,9 @@
 import asyncio
 import os
-from collections import Counter
 
 from otf_api import Otf
 from otf_api.models.responses.bookings import BookingStatus
-from otf_api.models.responses.classes import ClassType, DoW
+from otf_api.models.responses.classes import DoW
 
 USERNAME = os.getenv("OTF_EMAIL")
 PASSWORD = os.getenv("OTF_PASSWORD")
@@ -29,17 +28,6 @@ async def main():
     # client to filter the results
     classes = await otf.get_classes(studio_uuids, day_of_week=[DoW.tuesday, DoW.thursday, DoW.saturday])
 
-    # get all statuses
-    class_types = dict(
-        sorted(
-            Counter([c.name for c in classes.classes if c.class_type == ClassType.OTHER]).items(),
-            key=lambda x: x[1],
-            reverse=True,
-        )
-    )
-
-    print(class_types)
-
     print(classes.classes[0].model_dump_json(indent=4))
 
     """
@@ -72,8 +60,69 @@ async def main():
     # You can pass a start_date, end_date, status, and limit as arguments
 
     bookings = await otf.get_bookings()
+
+    print("Next Upcoming Class:")
     print(bookings.bookings[0].model_dump_json(indent=4))
 
+    """
+    {
+        "class_booking_id": 870700285,
+        "class_booking_uuid": "a36d76b1-0a55-4143-b96b-646e7520ca39",
+        "studio_id": 1234,
+        "class_id": 376344282,
+        "is_intro": false,
+        "member_id": 234488148,
+        "status": "Booked",
+        "booked_date": "2024-09-10T04:26:11Z",
+        "checked_in_date": null,
+        "cancelled_date": null,
+        "created_date": "2024-09-10T04:26:11Z",
+        "updated_date": "2024-09-10T04:26:13Z",
+        "is_deleted": false,
+        "waitlist_position": null,
+        "otf_class": {
+            "starts_at_local": "2024-09-28T10:30:00",
+            "ends_at_local": "2024-09-28T11:20:00",
+            "name": "Tread 50",
+            "class_uuid": "82ec9b55-950a-484f-818f-cd2344ce83fd",
+            "is_available": true,
+            "is_cancelled": false,
+            "program_name": "Group Fitness",
+            "coach_id": 1204786,
+            "studio": {
+                "studio_uuid": "49e360d1-f8ef-4091-a23f-61b321cb283c",
+                "studio_name": "AnyTown OH - East",
+                "description": "",
+                "status": "Active",
+                "time_zone": "America/Chicago",
+                "studio_id": 1267,
+                "allows_cr_waitlist": true
+            },
+            "coach": {
+                "coach_uuid": "973516a8-0c6b-41ec-916c-1da9913b9a16",
+                "name": "Friendly",
+                "first_name": "Friendly",
+                "last_name": "Coach"
+            },
+            "location": {
+                "address_one": "123 S Main St",
+                "address_two": null,
+                "city": "AnyTown",
+                "country": null,
+                "distance": null,
+                "latitude": 91.73407745,
+                "location_name": null,
+                "longitude": -80.92264626,
+                "phone_number": "2042348963",
+                "postal_code": "11111",
+                "state": "Ohio"
+            },
+            "virtual_class": null
+        },
+        "is_home_studio": true
+    }
+    """
+
 
 if __name__ == "__main__":
     asyncio.run(main())
diff --git a/examples/workout_examples.py b/examples/workout_examples.py
@@ -153,6 +153,13 @@ async def main():
                     "tread_speed": 1.34,
                     "tread_incline": 1.0,
                     "agg_tread_distance": 9
+                },
+                "row_data": {
+                    "row_speed": 1.0,
+                    "row_pps": 0.0,
+                    "row_Spm": 0.0,
+                    "agg_row_distance": 0,
+                    "row_pace": 0
                 }
             },
             {
@@ -165,6 +172,13 @@ async def main():
                     "tread_speed": 2.46,
                     "tread_incline": 1.0,
                     "agg_tread_distance": 62
+                },
+                "row_data": {
+                    "row_speed": 1.0,
+                    "row_pps": 0.0,
+                    "row_Spm": 0.0,
+                    "agg_row_distance": 0,
+                    "row_pace": 0
                 }
             },
             ...