Class User

Parameters

• params: { email: string; password: string }

  • email: string

  • password: string

Returns Promise<void>

Parameters

• params: { password: string }

  • password: string

Returns Promise<void>

Parameters

• params: { revision: string }

  • revision: string

Returns Promise<AcceptedTermsVersion>

Parameters

• params: { address?: string; company?: string; privacyUrl: string; termsUrl: string; websiteUrl?: string }

  • Optional address?: string

  • Optional company?: string

  • privacyUrl: string

  • termsUrl: string

  • Optional websiteUrl?: string

Returns Promise<DevelopmentAccount>

Parameters

• params: { email: string }

  • email: string

Returns Promise<EmailAddress>

Parameters

• params: { autoAttachSession?: boolean; heartRateDataPoints: HeartRateCapturedDataPoint[]; sessionId?: number; source: string }

  • Optional autoAttachSession?: boolean

  • heartRateDataPoints: HeartRateCapturedDataPoint[]

  • Optional sessionId?: number

  • source: string

Returns Promise<HeartRateDataSet>

Parameters

• params: { metricHeight: number; source: string; takenAt: Date }

  • metricHeight: number

  • source: string

  • takenAt: Date

Returns Promise<HeightMeasurement>

Parameters

• params: { challengeType: MSeriesChallengeType; endAt?: Date; focus: MSeriesChallengeFocus; goal?: number; isPublic: boolean; name: string; startAt?: Date; userLimit: number }

  • challengeType: MSeriesChallengeType

  • Optional endAt?: Date

  • focus: MSeriesChallengeFocus

  • Optional goal?: number

  • isPublic: boolean

  • name: string

  • Optional startAt?: Date

  • userLimit: number

Returns Promise<PrivilegedMSeriesChallenge>

Parameters

• params: { autoAttachSession?: boolean; buildMajor: number; buildMinor: number; mSeriesDataPoints: MSeriesCapturedDataPoint[]; machineType: string; ordinalId: number; sessionId?: number; source: string }

  • Optional autoAttachSession?: boolean

  • buildMajor: number

  • buildMinor: number

  • mSeriesDataPoints: MSeriesCapturedDataPoint[]

  • machineType: string

  • ordinalId: number

  • Optional sessionId?: number

  • source: string

Returns Promise<MSeriesDataSet>

Parameters

• params: { ftp: number; machineType: string; source: string; takenAt: Date }

  • ftp: number

  • machineType: string

  • source: string

  • takenAt: Date

Returns Promise<MSeriesFtpMeasurement>

Parameters

• params: { leftPosition?: string; model: string; rightPosition?: string; seat?: string; start?: string; stop?: string }

  • Optional leftPosition?: string

  • model: string

  • Optional rightPosition?: string

  • Optional seat?: string

  • Optional start?: string

  • Optional stop?: string

Returns Promise<MachineAdjustment>

Parameters

• params: { addedWeight?: number; autoAttachSession?: boolean; chest?: number; completedAt: Date; distance?: number; exerciseId?: number; facilityId?: number; forceUnit: ForceUnit; peakPower: number; repetitionCount: number; resistance: number; resistancePrecision: ResistancePrecision; rom1?: number; rom2?: number; seat?: number; serial: string; sessionId?: number; strengthMachineId: number; version: string; work: number }

  • Optional addedWeight?: number

  • Optional autoAttachSession?: boolean

  • Optional chest?: number

  • completedAt: Date

  • Optional distance?: number

  • Optional exerciseId?: number

  • Optional facilityId?: number

  • forceUnit: ForceUnit

  • peakPower: number

  • repetitionCount: number

  • resistance: number

  • resistancePrecision: ResistancePrecision

  • Optional rom1?: number

  • Optional rom2?: number

  • Optional seat?: number

  • serial: string

  • Optional sessionId?: number

  • strengthMachineId: number

  • version: string

  • work: number

Returns Promise<StrengthMachineDataSet>

Parameters

• params: { bodyFatPercentage?: number; metricWeight: number; source: string; takenAt: Date }

  • Optional bodyFatPercentage?: number

  • metricWeight: number

  • source: string

  • takenAt: Date

Returns Promise<WeightMeasurement>

Parameters

• params: { bodyComp: object }

  • bodyComp: object

Returns Promise<WeightMeasurement>

Parameters

• params: { bodyCompCSV: string }

  • bodyCompCSV: string

Returns Promise<WeightMeasurements>

Returns Promise<void>

Returns undefined | AcceptedTermsVersion

Returns undefined | HeightMeasurement[]

Returns undefined | OAuthService[]

Returns undefined | PrimaryEmailAddress

Returns Profile

Returns undefined | WeightMeasurement[]

Returns UserData

Parameters

• params: { code: string; shouldAuthorize: boolean }

  • code: string

  • shouldAuthorize: boolean

Returns Promise<DevelopmentAccountRelationship>

Parameters

• token: string

Returns Promise<void>

Parameters

• params: { id: number }

  • id: number

Returns Promise<DevelopmentAccount>

Parameters

• params: { code?: string; developmentAccountId?: number; id?: number }

  • Optional code?: string

  • Optional developmentAccountId?: number

  • Optional id?: number

Returns Promise<DevelopmentAccountRelationshipRequest>

Parameters

• options: { ascending?: boolean; company?: string; developmentAccountId?: number; email?: string; limit?: number; offset?: number; sort?: DevelopmentAccountRelationshipRequestSorting }

  • Optional ascending?: boolean

  • Optional company?: string

  • Optional developmentAccountId?: number

  • Optional email?: string

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: DevelopmentAccountRelationshipRequestSorting

Returns Promise<DevelopmentAccountRelationshipRequests>

Parameters

• options: { ascending?: boolean; limit?: number; offset?: number; sort?: DevelopmentAccountSorting }

  • Optional ascending?: boolean

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: DevelopmentAccountSorting

Returns Promise<DevelopmentAccounts>

Parameters

• options: { ascending?: boolean; email?: string; limit?: number; offset?: number; sort?: EmailAddressSorting } = {}

  • Optional ascending?: boolean

  • Optional email?: string

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: EmailAddressSorting

Returns Promise<EmailAddresses>

Parameters

• params: { id: number }

  • id: number

Returns Promise<UserFacilityEmployeeRelationship>

Parameters

• options: { ascending?: boolean; limit?: number; name?: string; offset?: number; sort?: UserFacilityRelationshipSorting } = {}

  • Optional ascending?: boolean

  • Optional limit?: number

  • Optional name?: string

  • Optional offset?: number

  • Optional sort?: UserFacilityRelationshipSorting

Returns Promise<UserFacilityEmployeeRelationships>

Parameters

• params: { id: number }

  • id: number

Returns Promise<UserFacilityMemberRelationship>

Parameters

• options: { ascending?: boolean; limit?: number; offset?: number; sort?: UserFacilityRelationshipSorting } = {}

  • Optional ascending?: boolean

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: UserFacilityRelationshipSorting

Returns Promise<UserFacilityMemberRelationships>

Parameters

• params: { id: number }

  • id: number

Returns Promise<UserFacilityRelationship>

Parameters

• params: { id: number }

  • id: number

Returns Promise<FacilityRelationshipRequest>

Parameters

• options: { ascending?: boolean; limit?: number; memberIdentifier?: string; name?: string; offset?: number; sort?: FacilityRelationshipRequestSorting } = {}

  • Optional ascending?: boolean

  • Optional limit?: number

  • Optional memberIdentifier?: string

  • Optional name?: string

  • Optional offset?: number

  • Optional sort?: FacilityRelationshipRequestSorting

Returns Promise<FacilityRelationshipRequests>

Returns Promise<GlobalAccessControl>

Parameters

• params: { id: number }

  • id: number

Returns Promise<HeartRateDataSet>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; offset?: number; sort?: HeartRateDataSetSorting; source?: string; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: HeartRateDataSetSorting

  • Optional source?: string

  • Optional to?: Date

Returns Promise<HeartRateDataSets>

Parameters

• params: { id: number }

  • id: number

Returns Promise<HeightMeasurement>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; offset?: number; sort?: HeightMeasurementSorting; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: HeightMeasurementSorting

  • Optional to?: Date

Returns Promise<HeightMeasurements>

Parameters

• params: (Without<{ id: number }, { joinCode: string }> & { joinCode: string }) | (Without<{ joinCode: string }, { id: number }> & { id: number })

Returns Promise<JoinableMSeriesChallenge | JoinedMSeriesChallenge | PrivilegedMSeriesChallenge>

Parameters

• params: { ascending?: boolean; from?: Date; isCompleted?: boolean; limit?: number; offset?: number; relationship?: MSeriesChallengeRelationship; sort?: MSeriesChallengeSorting; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional isCompleted?: boolean

  • Optional limit?: number

  • Optional offset?: number

  • Optional relationship?: MSeriesChallengeRelationship

  • Optional sort?: MSeriesChallengeSorting

  • Optional to?: Date

Returns Promise<JoinedMSeriesChallenges | PrivilegedMSeriesChallenges>

Parameters

• params: { graphResolution?: number; id: number }

  • Optional graphResolution?: number

  • id: number

Returns Promise<MSeriesDataSet>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; offset?: number; sort?: MSeriesDataSetSorting; source?: string; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: MSeriesDataSetSorting

  • Optional source?: string

  • Optional to?: Date

Returns Promise<MSeriesDataSets>

Parameters

• params: { id: number }

  • id: number

Returns Promise<MSeriesFtpMeasurement>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; machineType?: string; offset?: number; sort?: MSeriesFtpMeasurementSorting; source?: string; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional machineType?: string

  • Optional offset?: number

  • Optional sort?: MSeriesFtpMeasurementSorting

  • Optional source?: string

  • Optional to?: Date

Returns Promise<MSeriesFtpMeasurements>

Parameters

• params: { id: number }

  • id: number

Returns Promise<MachineAdjustment>

Parameters

• options: { ascending?: boolean; limit?: number; model?: string; offset?: number; sort?: ID }

  • Optional ascending?: boolean

  • Optional limit?: number

  • Optional model?: string

  • Optional offset?: number

  • Optional sort?: ID

Returns Promise<MachineAdjustments>

Parameters

• params: { id: number }

  • id: number

Returns Promise<OAuthService>

Parameters

• options: { limit?: number; offset?: number; service?: OAuthProviders } = {}

  • Optional limit?: number

  • Optional offset?: number

  • Optional service?: OAuthProviders

Returns Promise<OAuthServices>

Returns Promise<PrimaryEmailAddress>

Parameters

• params: { id: number }

  • id: number

Returns Promise<Session>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; offset?: number; open?: boolean; requireExtendedDataType?: SessionRequireExtendedDataType; sort?: SessionSorting; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional offset?: number

  • Optional open?: boolean

  • Optional requireExtendedDataType?: SessionRequireExtendedDataType

  • Optional sort?: SessionSorting

  • Optional to?: Date

Returns Promise<Sessions>

Parameters

• params: { id: number }

  • id: number

Returns Promise<StrengthMachineDataSet>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; offset?: number; sort?: StrengthMachineDataSetSorting; strengthMachineId?: number; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: StrengthMachineDataSetSorting

  • Optional strengthMachineId?: number

  • Optional to?: Date

Returns Promise<StrengthMachineDataSets>

Parameters

• params: { strengthMachineId: number }

  • strengthMachineId: number

Returns Promise<StrengthMachineProfileStats>

Parameters

• params: { id: number }

  • id: number

Returns Promise<WeightMeasurement>

Parameters

• options: { ascending?: boolean; from?: Date; limit?: number; offset?: number; sort?: WeightMeasurementSorting; to?: Date } = {}

  • Optional ascending?: boolean

  • Optional from?: Date

  • Optional limit?: number

  • Optional offset?: number

  • Optional sort?: WeightMeasurementSorting

  • Optional to?: Date

Returns Promise<WeightMeasurements>

Parameters

• params: { redirect: string; service: OAuthProviders }

  • redirect: string

  • service: OAuthProviders

Returns Promise<{ redirectUrl: string }>

Parameters

• params: { joinCode: string }

  • joinCode: string

Returns Promise<MSeriesChallengeParticipant>

Returns Promise<User>

Parameters

• params: { continueFromLastSet?: boolean; forceEndPrevious?: boolean; sessionPlanSequenceAssignmentId?: number } = {}

  • Optional continueFromLastSet?: boolean

  • Optional forceEndPrevious?: boolean

  • Optional sessionPlanSequenceAssignmentId?: number

Returns Promise<{ session: Session }>