Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Hierarchy

Index

Constructors

constructor

Accessors

acceptedTermsVersion

basicCredential

  • get basicCredential(): boolean

id

  • get id(): number

latestHeightMeasurement

latestWeightMeasurement

oauthServices

profile

Methods

addBasicLogin

  • addBasicLogin(email: string, password: string): Promise<void>

changePassword

  • changePassword(password: string): Promise<void>

createAcceptedTermsVersion

createEmailAddress

  • createEmailAddress(params: { email: string }): Promise<EmailAddress>

createHeartRateDataSet

createHeightMeasurement

  • createHeightMeasurement(params: { bodyFatPercentage?: undefined | number; imperialHeight?: undefined | number; metricHeight?: undefined | number; source: string; takenAt: Date }): Promise<HeightMeasurement>
  • Parameters

    • params: { bodyFatPercentage?: undefined | number; imperialHeight?: undefined | number; metricHeight?: undefined | number; source: string; takenAt: Date }
      • Optional bodyFatPercentage?: undefined | number
      • Optional imperialHeight?: undefined | number
      • Optional metricHeight?: undefined | number
      • source: string
      • takenAt: Date

    Returns Promise<HeightMeasurement>

createMSeriesDataSet

  • createMSeriesDataSet(params: { autoAttachSession?: undefined | false | true; buildMajor: number; buildMinor: number; mSeriesDataPoints: MSeriesCapturedDataPoint[]; machineType: string; ordinalId: number; sessionId?: undefined | number; source: string }): Promise<MSeriesDataSet>
  • Parameters

    • params: { autoAttachSession?: undefined | false | true; buildMajor: number; buildMinor: number; mSeriesDataPoints: MSeriesCapturedDataPoint[]; machineType: string; ordinalId: number; sessionId?: undefined | number; source: string }
      • Optional autoAttachSession?: undefined | false | true
      • buildMajor: number
      • buildMinor: number
      • mSeriesDataPoints: MSeriesCapturedDataPoint[]
      • machineType: string
      • ordinalId: number
      • Optional sessionId?: undefined | number
      • source: string

    Returns Promise<MSeriesDataSet>

createMSeriesFtpMeasurement

  • createMSeriesFtpMeasurement(params: { ftp: number; machineType: string; source: string; takenAt: Date }): Promise<MSeriesFtpMeasurement>
  • Parameters

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

    Returns Promise<MSeriesFtpMeasurement>

createOAuthService

  • createOAuthService(params: { redirect: string; service: OAuthProviders }): Promise<string>

createStrengthMachineDataSet

  • createStrengthMachineDataSet(params: { addedWeight?: undefined | number; autoAttachSession?: undefined | false | true; chest?: undefined | number; completedAt: Date; distance?: undefined | number; exerciseId?: undefined | number; facilityId?: undefined | number; forceUnit: ForceUnit; peakPower: number; repetitionCount: number; resistance: number; resistancePrecision: ResistancePrecision; rom1?: undefined | number; rom2?: undefined | number; seat?: undefined | number; serial: string; sessionId?: undefined | number; strengthMachineId: number; version: string; work: number }): Promise<StrengthMachineDataSet>
  • Parameters

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

    Returns Promise<StrengthMachineDataSet>

createWeightMeasurement

  • createWeightMeasurement(params: { bodyFatPercentage?: undefined | number; imperialWeight?: undefined | number; metricWeight?: undefined | number; source: string; takenAt: Date }): Promise<WeightMeasurement>
  • Parameters

    • params: { bodyFatPercentage?: undefined | number; imperialWeight?: undefined | number; metricWeight?: undefined | number; source: string; takenAt: Date }
      • Optional bodyFatPercentage?: undefined | number
      • Optional imperialWeight?: undefined | number
      • Optional metricWeight?: undefined | number
      • source: string
      • takenAt: Date

    Returns Promise<WeightMeasurement>

delete

  • delete(): Promise<void>

getEmailAddresses

  • getEmailAddresses(options?: { ascending?: undefined | false | true; email?: undefined | string; limit?: undefined | number; offset?: undefined | number; sort?: EmailAddressSorting }): Promise<EmailAddresses>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; email?: undefined | string; limit?: undefined | number; offset?: undefined | number; sort?: EmailAddressSorting } = { }
      • Optional ascending?: undefined | false | true
      • Optional email?: undefined | string
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number
      • Optional sort?: EmailAddressSorting

    Returns Promise<EmailAddresses>

getExercises

  • getExercises(options?: { ascending?: undefined | false | true; limit?: undefined | number; name?: undefined | string; offset?: undefined | number; sort?: ExerciseSorting; type?: ExerciseType }): Promise<Exercises>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; limit?: undefined | number; name?: undefined | string; offset?: undefined | number; sort?: ExerciseSorting; type?: ExerciseType } = { }
      • Optional ascending?: undefined | false | true
      • Optional limit?: undefined | number
      • Optional name?: undefined | string
      • Optional offset?: undefined | number
      • Optional sort?: ExerciseSorting
      • Optional type?: ExerciseType

    Returns Promise<Exercises>

getFacilities

  • getFacilities(options?: { address?: undefined | string; ascending?: undefined | false | true; city?: undefined | string; country?: undefined | string; limit?: undefined | number; name?: undefined | string; offset?: undefined | number; phone?: undefined | string; postcode?: undefined | string; sort?: FacilitySorting; state?: undefined | string }): Promise<Facilities>
  • Parameters

    • Default value options: { address?: undefined | string; ascending?: undefined | false | true; city?: undefined | string; country?: undefined | string; limit?: undefined | number; name?: undefined | string; offset?: undefined | number; phone?: undefined | string; postcode?: undefined | string; sort?: FacilitySorting; state?: undefined | string } = { }
      • Optional address?: undefined | string
      • Optional ascending?: undefined | false | true
      • Optional city?: undefined | string
      • Optional country?: undefined | string
      • Optional limit?: undefined | number
      • Optional name?: undefined | string
      • Optional offset?: undefined | number
      • Optional phone?: undefined | string
      • Optional postcode?: undefined | string
      • Optional sort?: FacilitySorting
      • Optional state?: undefined | string

    Returns Promise<Facilities>

getFacilityEmploymentRelationships

getFacilityMembershipRelationships

getHeartRateDataSets

  • getHeartRateDataSets(options?: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: HeartRateDataSetSorting; source?: undefined | string; to?: Date }): Promise<HeartRateDataSets>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: HeartRateDataSetSorting; source?: undefined | string; to?: Date } = { }
      • Optional ascending?: undefined | false | true
      • Optional from?: Date
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number
      • Optional sort?: HeartRateDataSetSorting
      • Optional source?: undefined | string
      • Optional to?: Date

    Returns Promise<HeartRateDataSets>

getHeightMeasurements

  • getHeightMeasurements(options?: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: HeightMeasurementSorting; to?: Date }): Promise<HeightMeasurements>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: HeightMeasurementSorting; to?: Date } = { }
      • Optional ascending?: undefined | false | true
      • Optional from?: Date
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number
      • Optional sort?: HeightMeasurementSorting
      • Optional to?: Date

    Returns Promise<HeightMeasurements>

getMSeriesDataSets

  • getMSeriesDataSets(options?: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: MSeriesDataSetSorting; source?: undefined | string; to?: Date }): Promise<MSeriesDataSets>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: MSeriesDataSetSorting; source?: undefined | string; to?: Date } = { }
      • Optional ascending?: undefined | false | true
      • Optional from?: Date
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number
      • Optional sort?: MSeriesDataSetSorting
      • Optional source?: undefined | string
      • Optional to?: Date

    Returns Promise<MSeriesDataSets>

getMSeriesFtpMeasurements

  • getMSeriesFtpMeasurements(options?: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; machineType?: undefined | string; offset?: undefined | number; sort?: MSeriesFtpMeasurementSorting; source?: undefined | string; to?: Date }): Promise<MSeriesFtpMeasurements>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; machineType?: undefined | string; offset?: undefined | number; sort?: MSeriesFtpMeasurementSorting; source?: undefined | string; to?: Date } = { }
      • Optional ascending?: undefined | false | true
      • Optional from?: Date
      • Optional limit?: undefined | number
      • Optional machineType?: undefined | string
      • Optional offset?: undefined | number
      • Optional sort?: MSeriesFtpMeasurementSorting
      • Optional source?: undefined | string
      • Optional to?: Date

    Returns Promise<MSeriesFtpMeasurements>

getOAuthServices

  • getOAuthServices(options?: { limit?: undefined | number; offset?: undefined | number }): Promise<OAuthServices>
  • Parameters

    • Default value options: { limit?: undefined | number; offset?: undefined | number } = { }
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number

    Returns Promise<OAuthServices>

getSessions

  • getSessions(options?: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; open?: undefined | false | true; sort?: SessionSorting; to?: Date }): Promise<Sessions>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; open?: undefined | false | true; sort?: SessionSorting; to?: Date } = { }
      • Optional ascending?: undefined | false | true
      • Optional from?: Date
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number
      • Optional open?: undefined | false | true
      • Optional sort?: SessionSorting
      • Optional to?: Date

    Returns Promise<Sessions>

getStrengthMachineDataSets

getWeightMeasurements

  • getWeightMeasurements(options?: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: WeightMeasurementSorting; to?: Date }): Promise<WeightMeasurements>
  • Parameters

    • Default value options: { ascending?: undefined | false | true; from?: Date; limit?: undefined | number; offset?: undefined | number; sort?: WeightMeasurementSorting; to?: Date } = { }
      • Optional ascending?: undefined | false | true
      • Optional from?: Date
      • Optional limit?: undefined | number
      • Optional offset?: undefined | number
      • Optional sort?: WeightMeasurementSorting
      • Optional to?: Date

    Returns Promise<WeightMeasurements>

reload

  • reload(): Promise<this>

startSession

  • startSession(params?: { forceEndPrevious?: undefined | false | true; sessionPlanSequenceAssignmentId?: undefined | number }): Promise<Session>
  • Parameters

    • Default value params: { forceEndPrevious?: undefined | false | true; sessionPlanSequenceAssignmentId?: undefined | number } = {}
      • Optional forceEndPrevious?: undefined | false | true
      • Optional sessionPlanSequenceAssignmentId?: undefined | number

    Returns Promise<Session>