Class Workouts

The Workouts class is used to interact with the workouts section of the Hevy API. It provides methods for retrieving, creating, and managing workouts on the account.

Index

Methods

createWorkout getWorkoutByID getWorkoutCount getWorkouts

Methods

createWorkout

createWorkout(
    workout: {
        description?: string;
        end_time: Date;
        exercises: {
            exercise_template_id: string;
            notes?: string;
            sets?: {
                custom_metric?: number;
                distance_meters?: number;
                duration_seconds?: number;
                reps?: number;
                rpe?: number;
                type: string;
                weight_kg?: number;
            }[];
            superset_id?: null
            | string;
        }[];
        is_private: boolean;
        start_time: Date;
        title: string;
    },
): Promise<any>
Creates a new workout.
Parameters
- workout: {
      description?: string;
      end_time: Date;
      exercises: {
          exercise_template_id: string;
          notes?: string;
          sets?: {
              custom_metric?: number;
              distance_meters?: number;
              duration_seconds?: number;
              reps?: number;
              rpe?: number;
              type: string;
              weight_kg?: number;
          }[];
          superset_id?: null
          | string;
      }[];
      is_private: boolean;
      start_time: Date;
      title: string;
  }
  The workout object to create.
Returns Promise<any>
The newly created workout data.
Throws
ValidationError if the provided workout data is invalid.
Example
```
import { HevyClient } from 'hevy-sdk';

const client = new HevyClient('your-api-key');
const newWorkout = await workouts.createWorkout(validWorkoutObject);
```

getWorkoutByID

getWorkoutByID(workoutID: string): Promise<any>
Retrieves a specific workout by workoutID.
Parameters
- workoutID: string
  The unique ID of the workout to retrieve.
Returns Promise<any>
The workout data for the specified workout ID.
Throws
Error if the workoutID is invalid or missing.
Example
```
import { HevyClient } from 'hevy-sdk';

const client = new HevyClient('your-api-key');
const workout = await client.workouts.getWorkoutByID("workout-id");
```

getWorkoutCount

getWorkoutCount(): Promise<any>
Retrieves the total number of workouts on the account.

Returns Promise<any>
The total workout count.
Throws
Error if the API request fails.
Example
```
import { HevyClient } from 'hevy-sdk';

const client = new HevyClient('your-api-key');
const count = await client.workouts.getWorkoutCount();
```

getWorkouts

getWorkouts(page: number, pageSize: number): Promise<any>
Retrieves a list of workouts from the API.
Parameters
- page: number
  The page number for pagination. Must be a positive integer.
- pageSize: number
  The number of workouts per page. Must be a positive integer and no greater than 10.
Returns Promise<any>
A list of workouts.
Throws
Error if the page or pageSize is invalid.
Example
```
import { HevyClient } from 'hevy-sdk';

const client = new HevyClient('your-api-key');
const workouts = await client.workouts.getWorkouts(1, 10);
```

Class Workouts

Index

Methods

Methods

createWorkout

Parameters

Returns Promise<any>

Throws

Example

getWorkoutByID

Parameters

Returns Promise<any>

Throws

Example

getWorkoutCount

Returns Promise<any>

Throws

Example

getWorkouts

Parameters

Returns Promise<any>

Throws

Example

Settings

On This Page