Class FolderService

Service for workout folders and training plans

Index

Constructors

Methods

applyPlanChanges create delete getSharedWith importWorkout list update updatePlanWorkouts updateSharedWith

Constructors

constructor

new FolderService(
httpClient: IHttpClient,
defaultAthleteId: string,
): FolderService
Parameters
- httpClient: IHttpClient
- defaultAthleteId: string
Returns FolderService
- Defined in services/folder.service.ts:8

Methods

applyPlanChanges

applyPlanChanges(
data: Record<string, unknown>,
athleteId?: string,
): Promise<Record<string, unknown>>
Apply plan changes to the calendar
Parameters
- data: Record<string, unknown>
- OptionalathleteId: string
Returns Promise<Record<string, unknown>>
- Defined in services/folder.service.ts:74

create

create(data: CreateFolderDTO, athleteId?: string): Promise<Folder>
Create a new folder or plan
Parameters
- data: CreateFolderDTO
- OptionalathleteId: string
Returns Promise<Folder>
- Defined in services/folder.service.ts:20

delete

delete(folderId: number, athleteId?: string): Promise<void>
Delete a folder/plan
Parameters
- folderId: number
- OptionalathleteId: string
Returns Promise<void>
- Defined in services/folder.service.ts:32

getSharedWith

getSharedWith(folderId: number, athleteId?: string): Promise<SharedWith[]>
Get athletes a folder is shared with
Parameters
- folderId: number
- OptionalathleteId: string
Returns Promise<SharedWith[]>
- Defined in services/folder.service.ts:56

importWorkout

importWorkout(
    folderId: number,
    file: Buffer<ArrayBufferLike> | Blob | Uint8Array<ArrayBufferLike>,
    fileName: string,
    athleteId?: string,
): Promise<Workout>
Import a workout file (.zwo, .mrc, .erg, .fit) into a folder
Parameters
- folderId: number
- file: Buffer<ArrayBufferLike> | Blob | Uint8Array<ArrayBufferLike>
- fileName: string
- OptionalathleteId: string
Returns Promise<Workout>
- Defined in services/folder.service.ts:68

list

list(athleteId?: string): Promise<Folder[]>
List all folders/plans for an athlete
Parameters
- OptionalathleteId: string
Returns Promise<Folder[]>
- Defined in services/folder.service.ts:14

update

update(
    folderId: number,
    data: Partial<Folder>,
    athleteId?: string,
): Promise<Folder>
Update a folder/plan
Parameters
- folderId: number
- data: Partial<Folder>
- OptionalathleteId: string
Returns Promise<Folder>
- Defined in services/folder.service.ts:26

updatePlanWorkouts

updatePlanWorkouts(
    folderId: number,
    data: { hide_from_athlete: boolean },
    range: { newest: number; oldest: number },
    athleteId?: string,
): Promise<Workout[]>
Update the plan's workouts dated between oldest and newest. The API currently changes only hide_from_athlete, so the body is typed to that one field; widen it when the route accepts more.

range.oldest and range.newest are the plan day numbers the spec declares (int32), not calendar dates: a plan's workouts are placed by day relative to the plan start.
Parameters
- folderId: number
- data: { hide_from_athlete: boolean }
- range: { newest: number; oldest: number }
- OptionalathleteId: string
Returns Promise<Workout[]>
- Defined in services/folder.service.ts:45

updateSharedWith

updateSharedWith(
    folderId: number,
    data: SharedWith[],
    athleteId?: string,
): Promise<SharedWith[]>
Update sharing settings for a folder
Parameters
- folderId: number
- data: SharedWith[]
- OptionalathleteId: string
Returns Promise<SharedWith[]>
- Defined in services/folder.service.ts:62