Merge pull request #285 from nickknissen/feat-traning-plans

Add training plans API support

Author: cyberjunky

README.md

@@ -3,7 +3,7 @@
 The Garmin Connect API library comes with two examples:
 
 - **`example.py`** - Simple getting-started example showing authentication, token storage, and basic API calls
-- **`demo.py`** - Comprehensive demo providing access to **100+ API methods** organized into **11 categories** for easy navigation
+- **`demo.py`** - Comprehensive demo providing access to **100+ API methods** organized into **12 categories** for easy navigation
 
 Note: The demo menu is generated dynamically; exact options may change between releases.
 
@@ -24,6 +24,7 @@ Select a category:
   [9] 🎽 Gear & Equipment
   [0] 💧 Hydration & Wellness
   [a] 🔧 System & Export
+  [b] 📅 Training plans
 
   [q] Exit program
 
@@ -45,6 +46,7 @@ Make your selection:
 - **Gear & Equipment**: 8 methods (gear management, tracking)
 - **Hydration & Wellness**: 9 methods (hydration, blood pressure, menstrual)
 - **System & Export**: 4 methods (reporting, logout, GraphQL)
+- **Training Plans**: 3 methods
 
 ### Interactive Features
 

demo.py

@@ -417,6 +417,13 @@ def __init__(self):
             "4": {"desc": "Execute GraphQL query", "key": "query_garmin_graphql"},
         },
     },
+    "b": {
+        "name": "📅 Training Plans",
+        "options": {
+            "1": {"desc": "Get training plans", "key": "get_training_plans"},
+            "2": {"desc": "Get training plan by ID", "key": "get_training_plan_by_id"},
+        },
+    },
 }
 
 current_category = None
@@ -1769,6 +1776,63 @@ def get_activity_exercise_sets_data(api: Garmin) -> None:
         print("ℹ️ No activity exercise sets available")
 
 
+def get_training_plan_by_id_data(api: Garmin) -> None:
+    """Get training plan details by ID (routes FBT_ADAPTIVE plans to the adaptive endpoint)."""
+    resp = api.get_training_plans() or {}
+    training_plans = resp.get("trainingPlanList") or []
+    if not training_plans:
+        print("ℹ️ No training plans found")
+        return
+
+    user_input = input("Enter training plan ID (press Enter for most recent): ").strip()
+    selected = None
+    if user_input:
+        try:
+            wanted_id = int(user_input)
+            selected = next(
+                (
+                    p
+                    for p in training_plans
+                    if int(p.get("trainingPlanId", 0)) == wanted_id
+                ),
+                None,
+            )
+            if not selected:
+                print(
+                    f"ℹ️ Plan ID {wanted_id} not found in your plans; attempting fetch anyway"
+                )
+                plan_id = wanted_id
+                plan_name = f"Plan {wanted_id}"
+                plan_category = None
+            else:
+                plan_id = int(selected["trainingPlanId"])
+                plan_name = selected.get("name", str(plan_id))
+                plan_category = selected.get("trainingPlanCategory")
+        except ValueError:
+            print("❌ Invalid plan ID")
+            return
+    else:
+        selected = training_plans[-1]
+        plan_id = int(selected["trainingPlanId"])
+        plan_name = selected.get("name", str(plan_id))
+        plan_category = selected.get("trainingPlanCategory")
+
+    if plan_category == "FBT_ADAPTIVE":
+        call_and_display(
+            api.get_adaptive_training_plan_by_id,
+            plan_id,
+            method_name="get_adaptive_training_plan_by_id",
+            api_call_desc=f"api.get_adaptive_training_plan_by_id({plan_id}) - {plan_name}",
+        )
+    else:
+        call_and_display(
+            api.get_training_plan_by_id,
+            plan_id,
+            method_name="get_training_plan_by_id",
+            api_call_desc=f"api.get_training_plan_by_id({plan_id}) - {plan_name}",
+        )
+
+
 def get_workout_by_id_data(api: Garmin) -> None:
     """Get workout by ID for the last workout."""
     try:
@@ -3186,6 +3250,12 @@ def execute_api_call(api: Garmin, key: str) -> None:
                 method_name="get_workouts",
                 api_call_desc="api.get_workouts()",
             ),
+            "get_training_plan_by_id": lambda: get_training_plan_by_id_data(api),
+            "get_training_plans": lambda: call_and_display(
+                api.get_training_plans,
+                method_name="get_training_plans",
+                api_call_desc="api.get_training_plans()",
+            ),
             "upload_activity": lambda: upload_activity_file(api),
             "download_activities": lambda: download_activities_by_date(api),
             "get_activity_splits": lambda: get_activity_splits_data(api),

garminconnect/__init__.py

@@ -266,6 +266,8 @@ def __init__(
 
         self.garmin_graphql_endpoint = "graphql-gateway/graphql"
 
+        self.garmin_connect_training_plan_url = "/trainingplan-service/trainingplan"
+
         self.garth = garth.Client(
             domain="garmin.cn" if is_cn else "garmin.com",
             pool_connections=20,
@@ -2209,6 +2211,31 @@ def logout(self) -> None:
             "Deprecated: Alternative is to delete the login tokens to logout."
         )
 
+    def get_training_plans(self) -> dict[str, Any]:
+        """Return all available training plans."""
+
+        url = f"{self.garmin_connect_training_plan_url}/plans"
+        logger.debug("Requesting training plans.")
+        return self.connectapi(url)
+
+    def get_training_plan_by_id(self, plan_id: int | str) -> dict[str, Any]:
+        """Return details for a specific training plan."""
+
+        plan_id = _validate_positive_integer(int(plan_id), "plan_id")
+
+        url = f"{self.garmin_connect_training_plan_url}/plans/{plan_id}"
+        logger.debug("Requesting training plan details for %s", plan_id)
+        return self.connectapi(url)
+
+    def get_adaptive_training_plan_by_id(self, plan_id: int | str) -> dict[str, Any]:
+        """Return details for a specific adaptive training plan."""
+
+        plan_id = _validate_positive_integer(int(plan_id), "plan_id")
+        url = f"{self.garmin_connect_training_plan_url}/fbt-adaptive/{plan_id}"
+
+        logger.debug("Requesting adaptive training plan details for %s", plan_id)
+        return self.connectapi(url)
+
 
 class GarminConnectConnectionError(Exception):
     """Raised when communication ended in error."""