Class AthleteService

Service for athlete-related operations

Index

Constructors

Methods

disconnectApp getAthlete getConnections getProfile getSettings getSummary getTrainingPlan listAthletes updateAthlete updateAthletePlans updateTrainingPlan

Constructors

constructor

new AthleteService(
httpClient: IHttpClient,
defaultAthleteId: string,
): AthleteService
Parameters
- httpClient: IHttpClient
- defaultAthleteId: string
Returns AthleteService
- Defined in services/athlete.service.ts:11

Methods

disconnectApp

disconnectApp(): Promise<void>
Disconnect the OAuth app that owns the current access token from the athlete's account. Irreversible from the API; the SDK never calls this in its live tests.

Returns Promise<void>
- Defined in services/athlete.service.ts:84

getAthlete

getAthlete(athleteId?: string): Promise<Athlete>
Get athlete information (includes sportSettings and custom_items)
Parameters
- OptionalathleteId: string
Returns Promise<Athlete>
- Defined in services/athlete.service.ts:17

getConnections

getConnections(athleteId?: string): Promise<AthleteConnections>
Which devices and platform apps the athlete has connected
Parameters
- OptionalathleteId: string
Returns Promise<AthleteConnections>
- Defined in services/athlete.service.ts:69

getProfile

getProfile(athleteId?: string): Promise<AthleteProfile>
Get athlete profile (public info, shared folders, custom items)
Parameters
- OptionalathleteId: string
Returns Promise<AthleteProfile>
- Defined in services/athlete.service.ts:46

getSettings

getSettings(
deviceClass: string,
athleteId?: string,
): Promise<Record<string, Record<string, unknown>>>
UI settings for a device class: a map of setting groups, each an open object (spec: object of objects).
Parameters
- deviceClass: string
- OptionalathleteId: string
Returns Promise<Record<string, Record<string, unknown>>>
- Defined in services/athlete.service.ts:75

getSummary

getSummary(
options?: { end?: string; start?: string; tags?: string[] },
athleteId?: string,
): Promise<SummaryWithCats[]>
Summary information (training load, fitness, categories) for the athlete and followed athletes over a date range.
Parameters
- Optionaloptions: { end?: string; start?: string; tags?: string[] }
- OptionalathleteId: string
Returns Promise<SummaryWithCats[]>
- Defined in services/athlete.service.ts:55

getTrainingPlan

getTrainingPlan(athleteId?: string): Promise<AthleteTrainingPlan>
Get the athlete's training plan
Parameters
- OptionalathleteId: string
Returns Promise<AthleteTrainingPlan>
- Defined in services/athlete.service.ts:29

listAthletes

listAthletes(options?: { extIdPrefix?: string }): Promise<AthleteWithTags[]>
Athletes the caller follows or coaches, including the caller. Requires API-key authentication (not available to OAuth app tokens).
Parameters
- Optionaloptions: { extIdPrefix?: string }
Returns Promise<AthleteWithTags[]>
- Defined in services/athlete.service.ts:63

updateAthlete

updateAthlete(data: AthleteUpdateDTO, athleteId?: string): Promise<Athlete>
Update athlete information
Parameters
- data: AthleteUpdateDTO
- OptionalathleteId: string
Returns Promise<Athlete>
- Defined in services/athlete.service.ts:23

updateAthletePlans

updateAthletePlans(
data: AthleteTrainingPlanUpdate[],
): Promise<Record<string, unknown>>
Change training plans for a list of athletes
Parameters
- data: AthleteTrainingPlanUpdate[]
Returns Promise<Record<string, unknown>>
- Defined in services/athlete.service.ts:41

updateTrainingPlan

updateTrainingPlan(
data: AthleteTrainingPlanUpdate,
athleteId?: string,
): Promise<AthleteTrainingPlan>
Change the athlete's training plan
Parameters
- data: AthleteTrainingPlanUpdate
- OptionalathleteId: string
Returns Promise<AthleteTrainingPlan>
- Defined in services/athlete.service.ts:35