@dlwiest/ts-tonal-client 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -19,242 +19,6 @@ interface OAuthTokenResponse {
 
 type MuscleGroup = 'Obliques' | 'Abs' | 'Shoulders' | 'Glutes' | 'Back' | 'Biceps' | 'Quads' | 'Triceps' | 'Chest' | 'Hamstrings' | 'Calves' | 'Forearms';
 
-interface TonalMovement {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    shortName: string;
-    muscleGroups: MuscleGroup[];
-    bodyRegion: string;
-    bodyRegionDisplay: string;
-    baseOfSupport: string;
-    pushPull: string;
-    family: string;
-    familyDisplay: string;
-    inFreeLift: boolean;
-    onMachine: boolean;
-    countReps: boolean;
-    isTwoSided: boolean;
-    isBilateral: boolean;
-    isAlternating: boolean;
-    offMachineAccessory: string;
-    descriptionHow: string;
-    descriptionWhy: string;
-    sortOrder: number;
-    imageAssetId: string;
-    skillLevel: number;
-    active: boolean;
-    featureGroupIds: null | string[];
-    isGeneric: boolean;
-}
-
-type WorkoutPublishState = 'published' | 'archived' | string;
-interface WorkoutSet {
-    id: string;
-    workoutId: string;
-    blockStart: boolean;
-    movementId: string;
-    prescribedReps?: number;
-    prescribedDuration?: number;
-    repetition: number;
-    repetitionTotal: number;
-    blockNumber: number;
-    burnout: boolean;
-    spotter: boolean;
-    eccentric: boolean;
-    chains: boolean;
-    skipSetup: boolean;
-    skipDemo: boolean;
-    finalSet: boolean;
-    calibration: boolean;
-    practice: boolean;
-    flex: boolean;
-    progressive: boolean;
-    weightPercentage: number;
-    warmUp: boolean;
-    durationBasedRepGoal: number;
-    setGroup: number;
-    round: number;
-    description: string;
-    dropSet: boolean;
-    omitempty?: unknown;
-}
-interface TonalWorkout {
-    id: string;
-    createdAt: string;
-    title: string;
-    shortDescription: string;
-    description: string;
-    productionCode: string;
-    assetId: string;
-    coachId: string;
-    sets: WorkoutSet[] | null;
-    duration: number;
-    publishState: WorkoutPublishState;
-    programId: string | null;
-    level: string;
-    groupIds: string[];
-    targetArea: string;
-    tags: string[] | null;
-    bodyRegions: MuscleGroup[] | null;
-    goalIds: string[] | null;
-    trainingEffectGoals: string[];
-    disableModification: boolean;
-    publishedAt: string;
-    localPublishedAt: string;
-    type: string;
-    userId: string;
-    style: string;
-    trainingType: string;
-    trainingTypeIds: string[] | null;
-    mobileFriendly: boolean;
-    live: boolean;
-    recoveryWeight: boolean;
-    supportedDevices: string[] | null;
-    featureGroupIds: string[] | null;
-    movementIds: string[] | null;
-    accessories?: string[];
-    muscleGroupsForExclusion: MuscleGroup[] | null;
-    playbackType: string;
-    isImported: boolean;
-    createdSource?: unknown | null;
-}
-interface TonalWorkoutSetActivity {
-    movementId: string;
-    prescribedReps?: number | null;
-    repetition?: number | null;
-    repetitionTotal?: number | null;
-    weightPercentage?: number | null;
-    baseWeight?: number | null;
-    eccentricWeight?: number | null;
-    chainsWeight?: number | null;
-    blockNumber?: number | null;
-    blockStart?: boolean | null;
-    sideNumber?: number | null;
-    setId?: string | null;
-    spotter?: boolean | null;
-}
-interface TonalWorkoutActivity {
-    id: string;
-    userId: string;
-    workoutId: string;
-    workoutType?: string | null;
-    beginTime: string;
-    endTime?: string | null;
-    totalDuration: number;
-    activeDuration?: number | null;
-    restDuration?: number | null;
-    totalMovements?: number | null;
-    totalSets: number;
-    totalReps: number;
-    totalVolume: number;
-    totalConcentricWork?: number | null;
-    percentCompleted?: number | null;
-    completed?: boolean | null;
-    workoutSetActivity: TonalWorkoutSetActivity[];
-    contentCard?: unknown;
-    deviceId?: string | null;
-    timezone?: string | null;
-    appVersion?: string | null;
-}
-interface TonalSharedWorkout {
-    id: string;
-    sharerUserId: string;
-    parentWorkoutId: string;
-    workoutSnapshotId: string;
-    workoutSnapshotHash: string;
-    deepLinkUrl: string;
-    workoutSnapshot: TonalWorkout;
-}
-interface TonalWorkoutEstimateSet {
-    blockStart: boolean;
-    movementId: string;
-    prescribedReps?: number;
-    prescribedDuration?: number;
-    dropSet: boolean;
-    repetition: number;
-    repetitionTotal: number;
-    blockNumber: number;
-    burnout: boolean;
-    spotter: boolean;
-    eccentric: boolean;
-    chains: boolean;
-    flex: boolean;
-    warmUp: boolean;
-    weightPercentage: number;
-    setGroup: number;
-    round: number;
-    description: string;
-}
-interface TonalWorkoutEstimateResponse {
-    duration: number;
-}
-interface TonalWorkoutCreateRequest {
-    title: string;
-    sets: TonalWorkoutEstimateSet[];
-    createdSource?: 'WorkoutBuilder' | 'FreeLift' | 'SharedWorkout' | 'DailyLift' | 'TonalWorkout' | 'WorkoutGenerator' | 'ActivityFeed';
-    shortDescription?: string;
-    description?: string;
-}
-interface TonalWorkoutUpdateRequest {
-    id: string;
-    title: string;
-    shortDescription?: string;
-    description?: string;
-    coachId: string;
-    sets: TonalWorkoutEstimateSet[];
-    level?: string;
-    assetId: string;
-    createdSource?: 'WorkoutBuilder' | 'FreeLift' | 'SharedWorkout' | 'DailyLift' | 'TonalWorkout' | 'WorkoutGenerator' | 'ActivityFeed';
-}
-
-interface TonalProgramWorkout {
-    id: string;
-    programId: string;
-    workoutId: string;
-    level: string;
-    workoutNumber: number;
-    workoutTitle: string;
-    programWeek: number;
-    programDay: number;
-    duration: number;
-}
-interface TonalProgramTrainingEffectGoal {
-    goalID: string;
-    score: number;
-    goalMet: boolean;
-}
-interface TonalProgram {
-    id: string;
-    createdAt: string;
-    name: string;
-    description: string;
-    productionCode: string;
-    workoutsPerWeek: number;
-    cadence: boolean[];
-    weeks: number;
-    publishState: string;
-    publishedAt: string;
-    level: string;
-    workouts: TonalWorkout[];
-    assetId: string;
-    goalIds: string[];
-    groupIds: string[];
-    coachId: string;
-    coachIds: string[];
-    trainingTypeIds: string[];
-    isAdjustable: boolean;
-    programWorkoutIds: string[];
-    programWorkouts: TonalProgramWorkout[];
-    nonComparableWorkouts: boolean;
-    mobileFriendly: boolean;
-    supportedDevices: string[] | null;
-    featureGroupIds: string[] | null;
-    excludeFromCoachHighlights: boolean;
-    trainingEffectGoals: TonalProgramTrainingEffectGoal[];
-}
-
 interface TonalUserDevice {
     deviceId: string;
     tonalDeviceId: string;
@@ -412,6 +176,17 @@ interface TonalCurrentStreak {
     updatedByActivityId: string;
 }
 type TonalStrengthBodyRegion = 'Upper Body' | 'Core' | 'Lower Body' | 'Overall' | string;
+interface TonalStrengthFamilyScore {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    workoutActivityId: string;
+    strengthFamily: string;
+    strengthBodyRegion: string;
+    score: number;
+    current: boolean;
+}
 interface TonalStrengthScore {
     id: string;
     createdAt: string;
@@ -422,7 +197,7 @@ interface TonalStrengthScore {
     bodyRegionDisplay: string;
     score: number;
     current: boolean;
-    familyActivity?: unknown[];
+    familyActivity?: TonalStrengthFamilyScore[];
 }
 interface TonalStrengthScoreHistoryEntry {
     id: string;
@@ -698,18 +473,504 @@ interface TonalUserInfo {
     primaryDeviceType: 'Classic' | string;
 }
 
-declare class TonalClient {
-    private authManager;
-    private httpClient;
-    private workoutService;
-    private movementService;
-    private userService;
-    private userInfo?;
-    private userInfoPromise?;
-    private constructor();
-    static create(credentials: {
-        username: string;
-        password: string;
+interface TonalMovement {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    shortName: string;
+    muscleGroups: MuscleGroup[];
+    bodyRegion: string;
+    bodyRegionDisplay: string;
+    baseOfSupport: string;
+    pushPull: string;
+    family: string;
+    familyDisplay: string;
+    inFreeLift: boolean;
+    onMachine: boolean;
+    countReps: boolean;
+    isTwoSided: boolean;
+    isBilateral: boolean;
+    isAlternating: boolean;
+    offMachineAccessory: string;
+    descriptionHow: string;
+    descriptionWhy: string;
+    sortOrder: number;
+    imageAssetId: string;
+    skillLevel: number;
+    active: boolean;
+    featureGroupIds: null | string[];
+    isGeneric: boolean;
+    onMachineInfo?: {
+        accessory: string;
+        resistanceType: string;
+        spotterDisabled: boolean;
+        eccentricDisabled: boolean;
+        chainsDisabled: boolean;
+        burnoutDisabled: boolean;
+    };
+}
+
+type WorkoutPublishState = 'published' | 'archived' | string;
+interface WorkoutSet {
+    id: string;
+    workoutId: string;
+    blockStart: boolean;
+    movementId: string;
+    prescribedReps?: number;
+    prescribedDuration?: number;
+    repetition: number;
+    repetitionTotal: number;
+    blockNumber: number;
+    burnout: boolean;
+    spotter: boolean;
+    eccentric: boolean;
+    chains: boolean;
+    skipSetup: boolean;
+    skipDemo: boolean;
+    finalSet: boolean;
+    calibration: boolean;
+    practice: boolean;
+    flex: boolean;
+    progressive: boolean;
+    weightPercentage: number;
+    warmUp: boolean;
+    durationBasedRepGoal: number;
+    setGroup: number;
+    round: number;
+    description: string;
+    dropSet: boolean;
+    omitempty?: unknown;
+}
+interface TonalWorkout {
+    id: string;
+    createdAt: string;
+    title: string;
+    shortDescription: string;
+    description: string;
+    productionCode: string;
+    assetId: string;
+    coachId: string;
+    sets: WorkoutSet[] | null;
+    duration: number;
+    publishState: WorkoutPublishState;
+    programId: string | null;
+    level: string;
+    groupIds: string[];
+    targetArea: string;
+    tags: string[] | null;
+    bodyRegions: MuscleGroup[] | null;
+    goalIds: string[] | null;
+    trainingEffectGoals: string[];
+    disableModification: boolean;
+    publishedAt: string;
+    localPublishedAt: string;
+    type: string;
+    userId: string;
+    style: string;
+    trainingType: string;
+    trainingTypeIds: string[] | null;
+    mobileFriendly: boolean;
+    live: boolean;
+    recoveryWeight: boolean;
+    supportedDevices: string[] | null;
+    featureGroupIds: string[] | null;
+    movementIds: string[] | null;
+    accessories?: string[];
+    muscleGroupsForExclusion: MuscleGroup[] | null;
+    playbackType: string;
+    isImported: boolean;
+    createdSource?: unknown | null;
+}
+/**
+ * A performed set returned as part of a completed workout activity.
+ *
+ * The history and single-activity endpoints expose different subsets. Fields
+ * beyond movementId are therefore optional, and values that Tonal may return
+ * as null remain nullable.
+ */
+interface TonalWorkoutSetActivity {
+    id?: string;
+    userId?: string;
+    workoutId?: string;
+    workoutActivityID?: string;
+    movementId: string;
+    prescribedReps?: number | null;
+    prescribedDuration?: number;
+    repetition?: number | null;
+    repetitionTotal?: number | null;
+    blockNumber?: number | null;
+    blockStart?: boolean | null;
+    burnout?: boolean;
+    calibration?: boolean;
+    chains?: boolean;
+    dropSet?: boolean;
+    eccentric?: boolean;
+    finalSet?: boolean;
+    flex?: boolean;
+    practice?: boolean;
+    progressive?: boolean;
+    skipDemo?: boolean;
+    skipSetup?: boolean;
+    spotter?: boolean | null;
+    warmUp?: boolean;
+    beginTime?: string;
+    endTime?: string;
+    beginTimeMCB?: number;
+    endTimeMCB?: number;
+    duration?: number;
+    durationBasedRepGoal?: number;
+    sideNumber?: number | null;
+    movementSide?: string;
+    setGroup?: number;
+    setId?: string | null;
+    round?: number;
+    sortOrder?: number;
+    weightPercentage?: number | null;
+    avgWeight?: number;
+    baseWeight?: number | null;
+    minWeight?: number;
+    maxWeight?: number;
+    suggestedWeight?: number;
+    suggestedWeightChange?: number;
+    eccentricWeight?: number | null;
+    eccentricWeightFrac?: number;
+    chainsWeight?: number | null;
+    chainsWeightFrac?: number;
+    romWeight?: number;
+    romWeightFrac?: number;
+    romWeightMode?: number;
+    offMachineModifiedWeight?: number;
+    maxSpottedWeight?: number;
+    weightControlMode?: number | null;
+    volume?: number;
+    totalVolume?: number;
+    totalOnMachineVolume?: number;
+    userWeightPounds?: number;
+    repCount?: number;
+    cvRepCount?: number;
+    repsInReserve?: number;
+    reps?: unknown[] | null;
+    dualMotorReps?: unknown[] | null;
+    oneRepMax?: number;
+    avgRom?: number;
+    rom?: number;
+    romLengthIn?: number;
+    meanMaxPos?: number;
+    avgVelocity?: number;
+    isoModeSpeed?: number;
+    concentricWork?: number;
+    totalConcentricWork?: number;
+    totalConDuration?: number;
+    maxConPower?: number;
+    velAtMaxConPower?: number;
+    weightAtMaxConPower?: number;
+    inconsistencyScore?: number;
+    strugglingScore?: number;
+    durationInconsistencyScore?: number;
+    durationStrugglingScore?: number;
+    maxVelInconsistencyScore?: number;
+    maxVelStrugglingScore?: number;
+    romInconsistencyScore?: number;
+    romStrugglingScore?: number;
+    inchesUpdated?: boolean;
+    powerUpdated?: boolean;
+    prs?: unknown[];
+    spotterMode?: string;
+    triggeredFeedback?: unknown | null;
+}
+/**
+ * Detailed completed workout data returned by
+ * GET /users/{userId}/workout-activities/{activityId}.
+ */
+interface TonalWorkoutActivity {
+    id: string;
+    userId: string;
+    workoutId: string;
+    subscriptionId?: string;
+    workoutType?: string | null;
+    beginTime: string;
+    endTime?: string | null;
+    totalDuration: number;
+    activeDuration?: number | null;
+    restDuration?: number | null;
+    totalMovements?: number | null;
+    totalSets: number;
+    totalReps: number;
+    totalVolume: number;
+    totalConcentricWork?: number | null;
+    percentCompleted?: number | null;
+    completed?: boolean | null;
+    recoveryWeight?: boolean;
+    hasAppleWatch?: boolean;
+    isFirstWorkoutOfDay?: boolean;
+    isSmartViewActivated?: boolean;
+    workoutSetActivity: TonalWorkoutSetActivity[];
+    contentCard?: unknown;
+    deletedAt?: string | null;
+    partnerActivityId?: string | null;
+    programEnrollmentId?: string;
+    programId?: string;
+    deviceId?: string | null;
+    timezone?: string | null;
+    appVersion?: string | null;
+    mcbServiceVersion?: string;
+}
+/**
+ * Workout summary returned by
+ * GET /users/{userId}/workout-summaries/{activityId}.
+ */
+interface TonalFormattedWorkoutSummary {
+    id: string;
+    deletedAt: string | null;
+    userId: string;
+    name: string;
+    workoutId: string;
+    isInProgram: boolean;
+    isGuidedWorkout: boolean;
+    isBaselineWorkout: boolean;
+    timestamp: string;
+    UTCTimestamp: string;
+    localTimestamp: string;
+    endTime: string;
+    timeZone: string;
+    assetID?: string | null;
+    targetArea: string;
+    duration: number;
+}
+interface TonalSharedWorkout {
+    id: string;
+    sharerUserId: string;
+    parentWorkoutId: string;
+    workoutSnapshotId: string;
+    workoutSnapshotHash: string;
+    deepLinkUrl: string;
+    workoutSnapshot: TonalWorkout;
+}
+interface TonalWorkoutEstimateSet {
+    blockStart: boolean;
+    movementId: string;
+    prescribedReps?: number;
+    prescribedDuration?: number;
+    dropSet: boolean;
+    repetition: number;
+    repetitionTotal: number;
+    blockNumber: number;
+    burnout: boolean;
+    spotter: boolean;
+    eccentric: boolean;
+    chains: boolean;
+    flex: boolean;
+    warmUp: boolean;
+    weightPercentage: number;
+    setGroup: number;
+    round: number;
+    description: string;
+}
+interface TonalWorkoutEstimateResponse {
+    duration: number;
+}
+interface TonalWorkoutCreateRequest {
+    title: string;
+    sets: TonalWorkoutEstimateSet[];
+    createdSource?: 'WorkoutBuilder' | 'FreeLift' | 'SharedWorkout' | 'DailyLift' | 'TonalWorkout' | 'WorkoutGenerator' | 'ActivityFeed';
+    shortDescription?: string;
+    description?: string;
+}
+interface TonalWorkoutUpdateRequest {
+    id: string;
+    title: string;
+    shortDescription?: string;
+    description?: string;
+    coachId: string;
+    sets: TonalWorkoutEstimateSet[];
+    level?: string;
+    assetId: string;
+    createdSource?: 'WorkoutBuilder' | 'FreeLift' | 'SharedWorkout' | 'DailyLift' | 'TonalWorkout' | 'WorkoutGenerator' | 'ActivityFeed';
+}
+
+interface TonalHealthExportOptions {
+    /** Include activities on or after this ISO-8601 date or timestamp. */
+    startDate?: string | Date;
+    /** Include activities on or before this ISO-8601 date or timestamp. */
+    endDate?: string | Date;
+    /** Maximum number of activities to include, newest first. */
+    limit?: number;
+    /** Include current muscle readiness. Defaults to true. */
+    includeMuscleReadiness?: boolean;
+    /** Include aggregate lifetime statistics. Defaults to true. */
+    includeLifetimeStatistics?: boolean;
+    /**
+     * Include activities imported into Tonal from another service.
+     * Defaults to false so the export contains Tonal workouts without duplicating
+     * data that may already be present in Apple Health or another health source.
+     */
+    includeExternalActivities?: boolean;
+    /**
+     * Fetch performed set, rep, and weight details for exported activities.
+     * Defaults to false. Details are fetched from paginated workout activity data.
+     */
+    includeSetDetails?: boolean;
+}
+interface TonalHealthExportSetEstimates {
+    /**
+     * Estimated total resistance across active cables, calculated as Tonal's
+     * reported total on-machine volume divided by completed reps.
+     */
+    averageResistancePounds?: number;
+    /**
+     * Estimated total one-rep max, scaled from Tonal's reported per-cable
+     * one-rep max by the estimated total resistance.
+     */
+    oneRepMaxPounds?: number;
+}
+interface TonalHealthExportSet {
+    setActivityId?: string;
+    movementId: string;
+    movementName?: string;
+    muscleGroups?: string[];
+    accessory?: string;
+    bilateral?: boolean;
+    twoSided?: boolean;
+    beginTime?: string;
+    endTime?: string;
+    durationSeconds?: number;
+    prescribedReps?: number;
+    prescribedDurationSeconds?: number;
+    completedReps?: number;
+    repsInReserve?: number;
+    repetition?: number;
+    repetitionTotal?: number;
+    sideNumber?: number;
+    movementSide?: string;
+    averageResistancePerCablePounds?: number;
+    baseResistancePerCablePounds?: number;
+    minimumResistancePerCablePounds?: number;
+    maximumResistancePerCablePounds?: number;
+    totalVolumePounds?: number;
+    estimatedOneRepMaxPerCablePounds?: number;
+    derivedEstimates?: TonalHealthExportSetEstimates;
+    rangeOfMotionInches?: number;
+    maxConcentricPowerWatts?: number;
+    warmUp?: boolean;
+    spotter?: boolean;
+    eccentric?: boolean;
+    chains?: boolean;
+    flex?: boolean;
+}
+interface TonalHealthExportActivity {
+    activityId: string;
+    workoutId: string;
+    source: 'tonal' | 'external';
+    name: string;
+    timestamp: string;
+    localTimestamp: string;
+    timeZone: string;
+    targetArea: string;
+    workoutType: string;
+    level: string;
+    durationSeconds: number;
+    timeUnderTensionSeconds: number;
+    totalReps: number;
+    totalVolumePounds: number;
+    totalWorkKilojoules: number;
+    completed: boolean;
+    guided: boolean;
+    inProgram: boolean;
+    baselineWorkout: boolean;
+    totalSets?: number;
+    activeDurationSeconds?: number;
+    restDurationSeconds?: number;
+    percentCompleted?: number;
+    sets?: TonalHealthExportSet[];
+}
+interface TonalHealthExportSummary {
+    workoutCount: number;
+    completedWorkoutCount: number;
+    totalDurationSeconds: number;
+    totalTimeUnderTensionSeconds: number;
+    totalReps: number;
+    totalVolumePounds: number;
+    totalWorkKilojoules: number;
+}
+interface TonalHealthExport {
+    schemaVersion: 1;
+    exportedAt: string;
+    period: {
+        start: string | null;
+        end: string | null;
+    };
+    summary: TonalHealthExportSummary;
+    activities: TonalHealthExportActivity[];
+    muscleReadiness?: TonalMuscleReadiness;
+    lifetimeStatistics?: TonalUserStatistics;
+}
+interface TonalHealthExportSource {
+    activities: TonalActivitySummary[];
+    muscleReadiness?: TonalMuscleReadiness;
+    lifetimeStatistics?: TonalUserStatistics;
+    activityDetails?: TonalWorkoutActivity[];
+    movements?: TonalMovement[];
+}
+
+interface TonalProgramWorkout {
+    id: string;
+    programId: string;
+    workoutId: string;
+    level: string;
+    workoutNumber: number;
+    workoutTitle: string;
+    programWeek: number;
+    programDay: number;
+    duration: number;
+}
+interface TonalProgramTrainingEffectGoal {
+    goalID: string;
+    score: number;
+    goalMet: boolean;
+}
+interface TonalProgram {
+    id: string;
+    createdAt: string;
+    name: string;
+    description: string;
+    productionCode: string;
+    workoutsPerWeek: number;
+    cadence: boolean[];
+    weeks: number;
+    publishState: string;
+    publishedAt: string;
+    level: string;
+    workouts: TonalWorkout[];
+    assetId: string;
+    goalIds: string[];
+    groupIds: string[];
+    coachId: string;
+    coachIds: string[];
+    trainingTypeIds: string[];
+    isAdjustable: boolean;
+    programWorkoutIds: string[];
+    programWorkouts: TonalProgramWorkout[];
+    nonComparableWorkouts: boolean;
+    mobileFriendly: boolean;
+    supportedDevices: string[] | null;
+    featureGroupIds: string[] | null;
+    excludeFromCoachHighlights: boolean;
+    trainingEffectGoals: TonalProgramTrainingEffectGoal[];
+}
+
+declare class TonalClient {
+    private authManager;
+    private httpClient;
+    private workoutService;
+    private movementService;
+    private userService;
+    private userInfo?;
+    private userInfoPromise?;
+    private constructor();
+    static create(credentials: {
+        username: string;
+        password: string;
         cacheDir?: string;
     }): Promise<TonalClient>;
     getMovements(useCache?: boolean): Promise<TonalMovement[]>;
@@ -727,6 +988,14 @@ declare class TonalClient {
     getStrengthScoreHistory(days?: TonalStrengthScoreHistoryLookback): Promise<TonalStrengthScoreHistoryEntry[]>;
     getWorkoutActivityById(activityId: string, useCache?: boolean): Promise<TonalWorkoutActivity>;
     getActivitySummaries(): Promise<TonalActivitySummary[]>;
+    /**
+     * Get a page of completed workout activities including performed set data.
+     */
+    getWorkoutActivities(offset?: number, limit?: number): Promise<TonalWorkoutActivity[]>;
+    /** Get every completed Tonal workout activity using paginated requests. */
+    getAllWorkoutActivities(pageSize?: number): Promise<TonalWorkoutActivity[]>;
+    getFormattedWorkoutSummary(activityId: string): Promise<TonalFormattedWorkoutSummary>;
+    getFormattedWorkoutSummaries(activityIds: string[], batchSize?: number): Promise<TonalFormattedWorkoutSummary[]>;
     getUserStatistics(): Promise<TonalUserStatistics>;
     getAchievementStats(): Promise<TonalAchievementStats>;
     getAchievements(): Promise<TonalEarnedAchievement[]>;
@@ -735,6 +1004,16 @@ declare class TonalClient {
     getProgramById(programId: string): Promise<TonalProgram>;
     getTargetScores(): Promise<TonalTargetScoresResponse>;
     getMetricScores(startWeek?: number): Promise<TonalMetricScoresResponse>;
+    /**
+     * Create a compact export intended for health analysis and data portability.
+     *
+     * The export excludes profile, device, and authentication details. Activities
+     * can be filtered by date and limited, and optional readiness and lifetime
+     * statistics can be omitted when a smaller data set is preferred.
+     */
+    getHealthExport(options?: TonalHealthExportOptions): Promise<TonalHealthExport>;
+    private paginateWorkoutActivities;
+    private getWorkoutActivityDetails;
     getUserWorkouts(offset?: number, limit?: number): Promise<TonalWorkout[]>;
     getDailyLifts(timeZone?: string): Promise<TonalWorkout[]>;
     getWorkoutById(workoutId: string): Promise<TonalWorkout>;
@@ -745,4 +1024,12 @@ declare class TonalClient {
     deleteWorkout(workoutId: string): Promise<void>;
 }
 
-export { MuscleGroup, OAuthTokenResponse, TonalAchievementCategory, TonalAchievementDefinition, TonalAchievementMilestone, TonalAchievementStats, TonalActivitySummary, TonalApiError, TonalCalendarTile, TonalClient, TonalClientError, TonalCompatibilityStatus, TonalCurrentStreak, TonalDailyMetrics, TonalDailySchedule, TonalDeviceRegistration, TonalEarnedAchievement, TonalGoal, TonalGoalMetric, TonalHomeCalendar, TonalMetricScore, TonalMetricScoresResponse, TonalMovement, TonalMuscleReadiness, TonalMuscleUtilization, TonalProgram, TonalProgramTrainingEffectGoal, TonalProgramWorkout, TonalSharedWorkout, TonalStrengthBodyRegion, TonalStrengthScore, TonalStrengthScoreHistoryEntry, TonalStrengthScoreHistoryLookback, TonalTargetScore, TonalTargetScoresResponse, TonalTrainingEffectGoal, TonalTrainingEffectGoalRelation, TonalTrainingEffectGoalsResponse, TonalTrainingType, TonalUserDevice, TonalUserGoal, TonalUserInfo, TonalUserPermissions, TonalUserSettings, TonalUserStatistics, TonalWorkout, TonalWorkoutActivity, TonalWorkoutCreateRequest, TonalWorkoutEstimateResponse, TonalWorkoutEstimateSet, TonalWorkoutSetActivity, TonalWorkoutSummaryData, TonalWorkoutUpdateRequest, WorkoutPublishState, WorkoutSet, TonalClient as default };
+/**
+ * Build a compact, privacy-conscious health export from Tonal API data.
+ *
+ * The export intentionally excludes profile details, account identifiers,
+ * device identifiers, application versions, and authentication data.
+ */
+declare function buildHealthExport(source: TonalHealthExportSource, options?: TonalHealthExportOptions, exportedAt?: Date): TonalHealthExport;
+
+export { MuscleGroup, OAuthTokenResponse, TonalAchievementCategory, TonalAchievementDefinition, TonalAchievementMilestone, TonalAchievementStats, TonalActivitySummary, TonalApiError, TonalCalendarTile, TonalClient, TonalClientError, TonalCompatibilityStatus, TonalCurrentStreak, TonalDailyMetrics, TonalDailySchedule, TonalDeviceRegistration, TonalEarnedAchievement, TonalFormattedWorkoutSummary, TonalGoal, TonalGoalMetric, TonalHealthExport, TonalHealthExportActivity, TonalHealthExportOptions, TonalHealthExportSet, TonalHealthExportSetEstimates, TonalHealthExportSource, TonalHealthExportSummary, TonalHomeCalendar, TonalMetricScore, TonalMetricScoresResponse, TonalMovement, TonalMuscleReadiness, TonalMuscleUtilization, TonalProgram, TonalProgramTrainingEffectGoal, TonalProgramWorkout, TonalSharedWorkout, TonalStrengthBodyRegion, TonalStrengthFamilyScore, TonalStrengthScore, TonalStrengthScoreHistoryEntry, TonalStrengthScoreHistoryLookback, TonalTargetScore, TonalTargetScoresResponse, TonalTrainingEffectGoal, TonalTrainingEffectGoalRelation, TonalTrainingEffectGoalsResponse, TonalTrainingType, TonalUserDevice, TonalUserGoal, TonalUserInfo, TonalUserPermissions, TonalUserSettings, TonalUserStatistics, TonalWorkout, TonalWorkoutActivity, TonalWorkoutCreateRequest, TonalWorkoutEstimateResponse, TonalWorkoutEstimateSet, TonalWorkoutSetActivity, TonalWorkoutSummaryData, TonalWorkoutUpdateRequest, WorkoutPublishState, WorkoutSet, buildHealthExport, TonalClient as default };