Merge pull request #296 from federicopellegatta/feat/workout-schedule

Add workout schedule API support

Author: cyberjunky

README.md

@@ -39,7 +39,7 @@ Make your selection:
 - **Daily Health & Activity**: 8 methods (today's health data)
 - **Advanced Health Metrics**: 10 methods (fitness metrics, HRV, VO2)
 - **Historical Data & Trends**: 6 methods (date range queries)
-- **Activities & Workouts**: 20 methods (comprehensive activity management)
+- **Activities & Workouts**: 21 methods (comprehensive activity management)
 - **Body Composition & Weight**: 8 methods (weight tracking, body composition)
 - **Goals & Achievements**: 15 methods (challenges, badges, goals)
 - **Device & Technical**: 7 methods (device info, settings)
@@ -66,7 +66,7 @@ A comprehensive Python3 API wrapper for Garmin Connect, providing access to heal
 This library enables developers to programmatically access Garmin Connect data including:
 
 - **Health Metrics**: Heart rate, sleep, stress, body composition, SpO2, HRV
-- **Activity Data**: Workouts, exercises, training status, performance metrics
+- **Activity Data**: Workouts, scheduled workouts, exercises, training status, performance metrics
 - **Device Information**: Connected devices, settings, alarms, solar data
 - **Goals & Achievements**: Personal records, badges, challenges, race predictions
 - **Historical Data**: Trends, progress tracking, date range queries

demo.py

@@ -266,6 +266,10 @@ def __init__(self):
             "l": {"desc": "Set activity type", "key": "set_activity_type"},
             "m": {"desc": "Create manual activity", "key": "create_manual_activity"},
             "n": {"desc": "Delete activity", "key": "delete_activity"},
+            "o": {
+                "desc": "Get scheduled workout by ID",
+                "key": "get_scheduled_workout_by_id",
+            },
         },
     },
     "6": {
@@ -1976,6 +1980,25 @@ def clean_step_ids(workout_segments):
             print("💡 Workout data validation failed")
 
 
+def get_scheduled_workout_by_id_data(api: Garmin) -> None:
+    """Get scheduled workout by ID."""
+    try:
+        scheduled_workout_id = input("Enter scheduled workout ID: ").strip()
+
+        if not scheduled_workout_id:
+            print("❌ Scheduled workout ID is required")
+            return
+
+        call_and_display(
+            api.get_scheduled_workout_by_id,
+            scheduled_workout_id,
+            method_name="get_scheduled_workout_by_id",
+            api_call_desc=f"api.get_scheduled_workout_by_id({scheduled_workout_id})",
+        )
+    except Exception as e:
+        print(f"❌ Error getting scheduled workout by ID: {e}")
+
+
 def set_body_composition_data(api: Garmin) -> None:
     """Set body composition data."""
     try:
@@ -3272,6 +3295,9 @@ def execute_api_call(api: Garmin, key: str) -> None:
             "get_workout_by_id": lambda: get_workout_by_id_data(api),
             "download_workout": lambda: download_workout_data(api),
             "upload_workout": lambda: upload_workout_data(api),
+            "get_scheduled_workout_by_id": lambda: get_scheduled_workout_by_id_data(
+                api
+            ),
             # Body Composition & Weight
             "get_body_composition": lambda: call_and_display(
                 api.get_body_composition,

garminconnect/__init__.py

@@ -267,6 +267,8 @@ def __init__(
 
         self.garmin_workouts = "/workout-service"
 
+        self.garmin_workouts_schedule_url = f"{self.garmin_workouts}/schedule"
+
         self.garmin_connect_delete_activity_url = "/activity-service/activity"
 
         self.garmin_graphql_endpoint = "graphql-gateway/graphql"
@@ -2146,6 +2148,18 @@ def upload_workout(
             raise ValueError("workout_json must be a JSON object or array")
         return self.garth.post("connectapi", url, json=payload, api=True).json()
 
+    def get_scheduled_workout_by_id(
+        self, scheduled_workout_id: int | str
+    ) -> dict[str, Any]:
+        """Return scheduled workout by ID"""
+
+        scheduled_workout_id = _validate_positive_integer(
+            int(scheduled_workout_id), "scheduled_workout_id"
+        )
+        url = f"{self.garmin_workouts_schedule_url}/{scheduled_workout_id}"
+        logger.debug("Requesting scheduled workout by id %d", scheduled_workout_id)
+        return self.connectapi(url)
+
     def get_menstrual_data_for_date(self, fordate: str) -> dict[str, Any]:
         """Return menstrual data for date."""