@flow-js/garmin-connect 1.6.6 → 1.6.8

package/dist/common/CFClient.d.ts

@@ -0,0 +1,22 @@
+import { Options, Response } from 'cloudscraper';
+import { Headers } from 'request';
+import { CookieJar as ToughCookieJar } from 'tough-cookie';
+export default class CFClient {
+    private cookies;
+    private headers;
+    constructor(headers: Headers);
+    serializeCookies(): ToughCookieJar.Serialized | undefined;
+    importCookies(cookies: ToughCookieJar.Serialized): void;
+    scraper(options: Options): Promise<Response>;
+    /**
+     * @param {string} downloadDir
+     * @param {string} url
+     * @param {*} data
+     */
+    downloadBlob(downloadDir: string | undefined, url: string, data?: any): Promise<unknown>;
+    get<T>(url: string, data?: any): Promise<T>;
+    post<T>(url: string, data: any): Promise<T>;
+    delete<T>(url: string): Promise<T>;
+    postJson<T>(url: string, data: any, headers: Headers): Promise<T>;
+    putJson<T>(url: string, data: any): Promise<T>;
+}

package/dist/common/CFClient.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cloudscraper_1 = __importDefault(require("cloudscraper"));
+const request_1 = __importDefault(require("request"));
+const tough_cookie_1 = require("tough-cookie");
+const qs_1 = __importDefault(require("qs"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const asJson = (body) => {
+    try {
+        const jsonBody = JSON.parse(body);
+        return jsonBody;
+    }
+    catch (e) {
+        // Do nothing
+    }
+    return body;
+};
+class CFClient {
+    constructor(headers) {
+        this.cookies = request_1.default.jar();
+        this.headers = headers || {};
+    }
+    serializeCookies() {
+        var _a;
+        return (_a = this.cookies._jar) === null || _a === void 0 ? void 0 : _a.serializeSync();
+    }
+    importCookies(cookies) {
+        const deserialized = tough_cookie_1.CookieJar.deserializeSync(cookies);
+        this.cookies = request_1.default.jar();
+        this.cookies._jar = deserialized;
+    }
+    async scraper(options) {
+        return new Promise((resolve) => {
+            (0, cloudscraper_1.default)(options, (err, res) => {
+                resolve(res);
+            });
+        });
+    }
+    /**
+     * @param {string} downloadDir
+     * @param {string} url
+     * @param {*} data
+     */
+    async downloadBlob(downloadDir = '', url, data) {
+        const queryData = qs_1.default.stringify(data);
+        const queryDataString = queryData ? `?${queryData}` : '';
+        const options = {
+            method: 'GET',
+            jar: this.cookies,
+            uri: `${url}${queryDataString}`,
+            headers: this.headers,
+            encoding: null
+        };
+        return new Promise((resolve) => {
+            (0, cloudscraper_1.default)(options, async (err, response, body) => {
+                const { headers } = response || {};
+                const { 'content-disposition': contentDisposition } = headers || {};
+                const downloadDirNormalized = path_1.default.normalize(downloadDir);
+                if (contentDisposition) {
+                    const defaultName = `garmin_connect_download_${Date.now()}`;
+                    const [, fileName = defaultName] = contentDisposition.match(/filename="?([^"]+)"?/) || [];
+                    const filePath = path_1.default.resolve(downloadDirNormalized, fileName);
+                    fs_1.default.writeFileSync(filePath, body);
+                    resolve(filePath);
+                }
+            });
+        });
+    }
+    async get(url, data) {
+        const queryData = qs_1.default.stringify(data);
+        const queryDataString = queryData ? `?${queryData}` : '';
+        const options = {
+            method: 'GET',
+            jar: this.cookies,
+            uri: `${url}${queryDataString}`,
+            headers: this.headers
+        };
+        const { body } = await this.scraper(options);
+        return asJson(body);
+    }
+    async post(url, data) {
+        const options = {
+            method: 'POST',
+            uri: url,
+            jar: this.cookies,
+            formData: data,
+            headers: this.headers
+        };
+        const { body } = await this.scraper(options);
+        return asJson(body);
+    }
+    async delete(url) {
+        const options = {
+            method: 'DELETE',
+            uri: url,
+            jar: this.cookies,
+            headers: this.headers
+        };
+        const { body } = await this.scraper(options);
+        return asJson(body);
+    }
+    async postJson(url, data, headers) {
+        const options = {
+            method: 'POST',
+            uri: url,
+            jar: this.cookies,
+            json: data,
+            headers: {
+                ...this.headers,
+                ...headers,
+                'Content-Type': 'application/json'
+            }
+        };
+        const { body } = await this.scraper(options);
+        return asJson(body);
+    }
+    async putJson(url, data) {
+        const options = {
+            method: 'PUT',
+            uri: url,
+            jar: this.cookies,
+            json: data,
+            headers: {
+                ...this.headers,
+                'Content-Type': 'application/json'
+            }
+        };
+        const { body } = await this.scraper(options);
+        return asJson(body);
+    }
+}
+exports.default = CFClient;
+//# sourceMappingURL=CFClient.js.map

package/dist/common/CFClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CFClient.js","sourceRoot":"","sources":["../../src/common/CFClient.ts"],"names":[],"mappings":";;;;;AAAA,gEAA+D;AAC/D,sDAAsD;AACtD,+CAA2D;AAC3D,4CAAoB;AACpB,4CAAoB;AACpB,gDAAwB;AAExB,MAAM,MAAM,GAAG,CAAI,IAAY,EAAK,EAAE;IAClC,IAAI;QACA,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,OAAO,QAAa,CAAC;KACxB;IAAC,OAAO,CAAC,EAAE;QACR,aAAa;KAChB;IACD,OAAO,IAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAqB,QAAQ;IAIzB,YAAY,OAAgB;QACxB,IAAI,CAAC,OAAO,GAAG,iBAAO,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,gBAAgB;;QACZ,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,IAAI,0CAAE,aAAa,EAAE,CAAC;IAC9C,CAAC;IAED,aAAa,CAAC,OAAkC;QAC5C,MAAM,YAAY,GAAG,wBAAc,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,iBAAO,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAgB;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,IAAA,sBAAY,EAAC,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBAC/B,OAAO,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAW,GAAG,EAAE,EAAE,GAAW,EAAE,IAAU;QACxD,MAAM,SAAS,GAAG,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,GAAG,EAAE,GAAG,GAAG,GAAG,eAAe,EAAE;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI;SACN,CAAC;QACb,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,IAAA,sBAAY,EAAC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAChD,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;gBACnC,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAC/C,OAAO,IAAI,EAAE,CAAC;gBAClB,MAAM,qBAAqB,GAAG,cAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBAC1D,IAAI,kBAAkB,EAAE;oBACpB,MAAM,WAAW,GAAG,2BAA2B,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;oBAC5D,MAAM,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC,GAC5B,kBAAkB,CAAC,KAAK,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;oBAC3D,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CACzB,qBAAqB,EACrB,QAAQ,CACX,CAAC;oBACF,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;oBACjC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBACrB;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,IAAU;QAChC,MAAM,SAAS,GAAG,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,GAAG,EAAE,GAAG,GAAG,GAAG,eAAe,EAAE;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;SACb,CAAC;QACb,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAI,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,IAAI,CAAI,GAAW,EAAE,IAAS;QAChC,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAI,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,MAAM,CAAI,GAAW;QACvB,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAI,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAI,GAAW,EAAE,IAAS,EAAE,OAAgB;QACtD,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE;gBACL,GAAG,IAAI,CAAC,OAAO;gBACf,GAAG,OAAO;gBACV,cAAc,EAAE,kBAAkB;aACrC;SACJ,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAI,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,GAAW,EAAE,IAAS;QACnC,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE;gBACL,GAAG,IAAI,CAAC,OAAO;gBACf,cAAc,EAAE,kBAAkB;aACrC;SACJ,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAI,IAAI,CAAC,CAAC;IAC3B,CAAC;CACJ;AAjID,2BAiIC"}

package/dist/common/DateUtils.d.ts

@@ -0,0 +1 @@
+export declare function toDateString(date: Date): string;

package/dist/common/DateUtils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toDateString = void 0;
+function toDateString(date) {
+    const offset = date.getTimezoneOffset();
+    const offsetDate = new Date(date.getTime() - offset * 60 * 1000);
+    const [dateString] = offsetDate.toISOString().split('T');
+    return dateString;
+}
+exports.toDateString = toDateString;
+//# sourceMappingURL=DateUtils.js.map

package/dist/common/DateUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateUtils.js","sourceRoot":"","sources":["../../src/common/DateUtils.ts"],"names":[],"mappings":";;;AAAA,SAAgB,YAAY,CAAC,IAAU;IACnC,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACxC,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACjE,MAAM,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzD,OAAO,UAAU,CAAC;AACtB,CAAC;AALD,oCAKC"}

package/dist/garmin/GarminConnect.d.ts

@@ -1,6 +1,5 @@
 import { HttpClient } from '../common/HttpClient';
-import { ExportFileTypeValue, GarminDomain, GCGearId, ICountActivities, IGarminTokens, IOauth1Token, IOauth2Token, ISocialProfile, IUserSettings, IWorkout, IWorkoutDetail, ListCoursesResponse, UploadFileTypeTypeValue } from './types';
-import Running from './workouts/Running';
+import { CreatedCourseResponse, ExportFileTypeValue, GarminDomain, GCGearId, ICountActivities, IGarminTokens, IOauth1Token, IOauth2Token, ISocialProfile, IUserSettings, IWorkout, IWorkoutDetail, ListCoursesResponse, UploadFileTypeTypeValue } from './types';
 import { SleepData } from './types/sleep';
 import { ActivitySubType, ActivityType, GCActivityId, IActivity } from './types/activity';
 import { GearData } from './types/gear';
@@ -27,56 +26,274 @@ export default class GarminConnect {
     private listeners;
     private url;
     constructor(credentials?: GCCredentials | undefined, domain?: GarminDomain);
+    /**
+     * Login to Garmin Connect with provided credentials or those set during construction
+     * @param username - Optional username to override the one in credentials
+     * @param password - Optional password to override the one in credentials
+     * @returns The GarminConnect instance for chaining
+     */
     login(username?: string, password?: string): Promise<GarminConnect>;
+    /**
+     * Exports OAuth tokens to files in the specified directory
+     * @param dirPath - Directory path where token files will be saved
+     */
     exportTokenToFile(dirPath: string): void;
+    /**
+     * Loads OAuth tokens from files in the specified directory
+     * @param dirPath - Directory path where token files are stored
+     * @throws Error if directory not found
+     */
     loadTokenByFile(dirPath: string): void;
+    /**
+     * Exports OAuth tokens as an object
+     * @returns Object containing OAuth1 and OAuth2 tokens
+     * @throws Error if tokens are not found
+     */
     exportToken(): IGarminTokens;
+    /**
+     * Loads OAuth tokens from provided token objects (e.g., from DB or localStorage)
+     * @param oauth1 - OAuth1 token object
+     * @param oauth2 - OAuth2 token object
+     */
     loadToken(oauth1: IOauth1Token, oauth2: IOauth2Token): void;
+    /**
+     * Retrieves the user's settings from Garmin Connect
+     * @returns User settings data
+     */
     getUserSettings(): Promise<IUserSettings>;
+    /**
+     * Retrieves the user's social profile from Garmin Connect
+     * @returns User's social profile data
+     */
     getUserProfile(): Promise<ISocialProfile>;
+    /**
+     * Retrieves a list of activities matching the specified criteria
+     * @param start - Optional starting index for pagination
+     * @param limit - Optional limit for pagination
+     * @param activityType - Optional activity type filter
+     * @param subActivityType - Optional activity subtype filter
+     * @returns Array of activities matching the criteria
+     */
     getActivities(start?: number, limit?: number, activityType?: ActivityType, subActivityType?: ActivitySubType): Promise<IActivity[]>;
+    /**
+     * Retrieves a specific activity by its ID
+     * @param activity - Object containing activityId
+     * @returns Details of the specified activity
+     * @throws Error if activityId is missing
+     */
     getActivity(activity: {
         activityId: GCActivityId;
     }): Promise<IActivity>;
+    /**
+     * Counts lifetime activities
+     * @returns Activity statistics including counts by type
+     */
     countActivities(): Promise<ICountActivities>;
+    /**
+     * Download activity original data file
+     *
+     * Use the activityId to download the original activity data. Usually this is supplied as a .zip file.
+     *
+     * @example
+     * ```js
+     * const [activity] = await GCClient.getActivities(0, 1);
+     * // Directory path is optional and defaults to the current working directory.
+     * // Downloads filename will be supplied by Garmin.
+     * GCClient.downloadOriginalActivityData(activity, './some/path/that/exists');
+     * ```
+     *
+     * @param activity - with activityId
+     * @param dir - directory to save the file
+     * @param type - 'zip' | 'gpx' | 'tcx' | 'kml' (default: 'zip')
+     */
     downloadOriginalActivityData(activity: {
         activityId: GCActivityId;
     }, dir: string, type?: ExportFileTypeValue): Promise<void>;
+    /**
+     * Uploads an activity file
+     * @param file
+     * @param format - 'fit' | 'gpx' | 'tcx'
+     */
     uploadActivity(file: string, format?: UploadFileTypeTypeValue): Promise<unknown>;
+    /**
+     * Deletes an activity by activityId
+     * @param activity - with activityId
+     * @returns void
+     *
+     * @example
+     * ```js
+     * const activities = await GCClient.getActivities(0, 1);
+     * const activity = activities[0];
+     * await GCClient.deleteActivity(activity);
+     * ```
+     */
     deleteActivity(activity: {
         activityId: GCActivityId;
     }): Promise<void>;
+    /**
+     * Gets the list of workouts
+     * @param start
+     * @param limit
+     */
     getWorkouts(start: number, limit: number): Promise<IWorkout[]>;
+    /**
+     * Gets the workout detail by workoutId
+     * @param workout
+     * @returns workout detail - IWorkoutDetail
+     */
     getWorkoutDetail(workout: {
         workoutId: string;
     }): Promise<IWorkoutDetail>;
+    /**
+     * Creates a new workout
+     *
+     * Use workoutBuilder to create the workout object. See the example in the examples/example-workout.js for more complex workouts.
+     *
+     * @param workout - workout detail
+     * @returns Response from the workout creation operation
+     *
+     * @example
+     * ```js
+     * const wb = new WorkoutBuilder(
+     *     WorkoutType.Running,
+     *     'Workout running ' + new Date().toISOString()
+     * );
+     *
+     * wb.addStep(
+     *     new Step(
+     *         StepType.Run,
+     *         TimeDuration.fromSeconds(45),
+     *         new NoTarget(),
+     *         'Comment for the step: Run for 45 seconds'
+     *     )
+     * );
+     *
+     * GCClient.createWorkout(wb.build());
+     * ```
+     */
     createWorkout(workout: IWorkoutDetail): Promise<Workout>;
-    addWorkout(workout: IWorkoutDetail | Running): Promise<IWorkoutDetail>;
-    addRunningWorkout(name: string, meters: number, description: string): Promise<IWorkoutDetail>;
+    /**
+     * Deletes a workout by workoutId
+     * @param workout - with workoutId
+     *
+     * @example
+     * ```js
+     * const workouts = await GCClient.getWorkouts();
+     * const id = workouts[0].workoutId;
+     * GCClient.deleteWorkout({ workoutId: id });
+     * ```
+     */
     deleteWorkout(workout: {
         workoutId: string;
     }): Promise<unknown>;
     /**
      * Schedule a workout by workoutId to a specific date
+     *
+     * To add a workout to your calendar, provide the workout id and the date to schedule it on.
+     *
      * @param workout - with workoutId
-     * @param scheduleDate - 'YYYY-MM-DD'
+     * @param scheduleDate - 'YYYY-MM-DD' format date string
+     *
+     * @example
+     * ```js
+     * const workouts = await GCClient.getWorkouts();
+     * const id = workouts[0].workoutId;
+     * GCClient.scheduleWorkout({ workoutId: id }, new Date('2025-12-01'));
+     * ```
      */
     scheduleWorkout(workout: {
         workoutId: string;
     }, scheduleDate: string): Promise<unknown>;
+    /**
+     * Retrieves step count for a specific date
+     * @param date - The date to get step count for, defaults to current date
+     * @returns Total step count for the specified date
+     * @throws Error if steps data not found for the date
+     */
     getSteps(date?: Date): Promise<number>;
+    /**
+     * Retrieves sleep data for a specific date
+     * @param date - The date to get sleep data for, defaults to current date
+     * @returns Sleep data for the specified date
+     * @throws Error if sleep data is invalid or empty
+     */
     getSleepData(date?: Date): Promise<SleepData>;
+    /**
+     * Calculates sleep duration for a specific date
+     *
+     * Retrieves hours and minutes slept for a given date.
+     *
+     * @param date - The date to get sleep duration for, defaults to current date
+     * @returns Object with hours and minutes of sleep
+     * @throws Error if sleep data is missing or invalid
+     *
+     * @example
+     * ```js
+     * const detailedSleep = await GCClient.getSleepDuration(new Date('2020-03-24'));
+     * console.log(`Hours: ${detailedSleep.hours}, Minutes: ${detailedSleep.minutes}`);
+     * ```
+     */
     getSleepDuration(date?: Date): Promise<{
         hours: number;
         minutes: number;
     }>;
+    /**
+     * Retrieves weight data for a specific date
+     * @param date - The date to get weight data for, defaults to current date
+     * @returns Weight data for the specified date
+     * @throws Error if weight data is invalid or empty
+     */
     getDailyWeightData(date?: Date): Promise<WeightData>;
+    /**
+     * Retrieves weight data in pounds for a specific date
+     * @param date - The date to get weight data for, defaults to current date
+     * @returns Weight in pounds for the specified date
+     * @throws Error if valid weight data not found for the date
+     */
     getDailyWeightInPounds(date?: Date): Promise<number>;
+    /**
+     * Retrieves hydration data in fluid ounces for a specific date
+     * @param date - The date to get hydration data for, defaults to current date
+     * @returns Hydration value in fluid ounces for the specified date
+     * @throws Error if hydration data is invalid or empty
+     */
     getDailyHydration(date?: Date): Promise<number>;
+    /**
+     * Updates weight data for a specific date
+     * @param date - The date for the weight data, defaults to current date
+     * @param lbs - Weight value in pounds
+     * @param timezone - Timezone string for correct timestamp conversion
+     * @returns Response from the weight update operation
+     * @throws Error if update fails
+     */
     updateWeight(date: Date | undefined, lbs: number, timezone: string): Promise<UpdateWeight>;
+    /**
+     * Updates hydration log with fluid ounces for a specific date
+     * @param date - The date for the hydration data, defaults to current date
+     * @param valueInOz - Hydration value in fluid ounces
+     * @returns Response from the hydration update operation
+     * @throws Error if update fails
+     */
     updateHydrationLogOunces(date: Date | undefined, valueInOz: number): Promise<WaterIntake>;
+    /**
+     * Retrieves golf summary data
+     * @returns Summary of golf activities
+     * @throws Error if golf summary data is invalid or empty
+     */
     getGolfSummary(): Promise<GolfSummary>;
+    /**
+     * Retrieves golf scorecard for a specific round
+     * @param scorecardId - ID of the scorecard to retrieve
+     * @returns Golf scorecard data
+     * @throws Error if golf scorecard data is invalid or empty
+     */
     getGolfScorecard(scorecardId: number): Promise<GolfScorecard>;
+    /**
+     * Retrieves heart rate data for a specific date
+     * @param date - The date to get heart rate data for, defaults to current date
+     * @returns Heart rate data for the specified date
+     * @throws Error if the operation fails
+     */
     getHeartRate(date?: Date): Promise<HeartRate>;
     /**
      * Returns the gear data for the user.
@@ -102,10 +319,42 @@ export default class GarminConnect {
      * @return GearData - the unlinked gear item data
      */
     unlinkGearFromActivity(activityId: GCActivityId, gearId: GCGearId): Promise<GearData>;
+    /**
+     * Retrieves all workouts
+     * @returns List of workouts
+     */
     workouts(): Promise<Workout[]>;
+    /**
+     * Imports GPX file content
+     *
+     * @example ./examples/example-gpx-file.js
+     * @param fileName - Name of the GPX file
+     * @param fileContent - Content of the GPX file as string
+     * @returns Response from the GPX import operation
+     */
     importGpx(fileName: string, fileContent: string): Promise<ImportedGpxResponse>;
-    createCourse(activityType: GpxActivityType, courseName: string, geoPoints: GeoPoint[], coursePoints?: CoursePoint[]): Promise<unknown>;
+    /**
+     * Creates a course from GPX data
+     * You can get geoPoints and coursePoints from the imported GPX file response.
+     *
+     * @example ./examples/example-gpx-file.js
+     * @param activityType - Type of activity for the course
+     * @param courseName - Name of the course
+     * @param geoPoints - Array of geographical points making up the course
+     * @param coursePoints - Optional array of course points (waypoints)
+     * @returns Response from the course creation operation
+     */
+    createCourse(activityType: GpxActivityType, courseName: string, geoPoints: GeoPoint[], coursePoints?: CoursePoint[]): Promise<CreatedCourseResponse>;
+    /**
+     * Lists all courses
+     * @returns List of courses
+     */
     listCourses(): Promise<ListCoursesResponse>;
+    /**
+     * Exports a course as GPX file content
+     * @param courseId - ID of the course to export
+     * @returns GPX file content as string
+     */
     exportCourseAsGpx(courseId: number): Promise<string>;
     /**
      * Retrieves calendar events for a specific year.
@@ -132,7 +381,25 @@ export default class GarminConnect {
      * @param newName
      */
     renameActivity(activityId: GCActivityId, newName: string): Promise<void>;
+    /**
+     * Performs a GET request to the specified URL
+     * @param url - URL to send the request to
+     * @param data - Optional query parameters or request configuration
+     * @returns Response data of type T
+     */
     get<T>(url: string, data?: any): Promise<T>;
+    /**
+     * Performs a POST request to the specified URL
+     * @param url - URL to send the request to
+     * @param data - Data to send in the request body
+     * @returns Response data of type T
+     */
     post<T>(url: string, data: any): Promise<T>;
+    /**
+     * Performs a PUT request to the specified URL
+     * @param url - URL to send the request to
+     * @param data - Data to send in the request body
+     * @returns Response data of type T
+     */
     put<T>(url: string, data: any): Promise<T>;
 }