Search
Preparing search index...
The search index is not available
Keiser Metrics SDK API - v4.15.1
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Keiser Metrics SDK API - v4.15.1
models/user
FacilityEmployeeUser
Class FacilityEmployeeUser
Hierarchy
FacilityUser
FacilityEmployeeUser
Index
Constructors
constructor
Accessors
basic
Credential
facility
Relationship
Id
id
on
Model
Change
Event
Methods
add
Basic
Login
change
Password
create
Accepted
Terms
Version
create
Development
Account
create
Email
Address
create
Heart
Rate
Data
Set
create
Height
Measurement
createMSeries
Challenge
createMSeries
Data
Set
createMSeries
Ftp
Measurement
create
Machine
Adjustment
create
Strength
Machine
Data
Set
create
Weight
Measurement
create
Weight
Measurement
From
InBody
create
Weight
Measurements
From
InBodyCSV
delete
eager
Accepted
Terms
Version
eager
Height
Measurements
eagerOAuth
Services
eager
Primary
Email
Address
eager
Profile
eager
Weight
Measurements
eject
Data
fulfill
Development
Account
Relationship
Request
fulfill
Email
Validation
get
Development
Account
get
Development
Account
Relationship
Request
get
Development
Account
Relationship
Requests
get
Development
Accounts
get
Email
Addresses
get
Facility
Employee
Relationship
get
Facility
Employment
Relationships
get
Facility
Membership
Relationship
get
Facility
Membership
Relationships
get
Facility
Relationship
get
Facility
Relationship
Request
get
Facility
Relationship
Requests
get
Global
Access
Control
get
Heart
Rate
Data
Set
get
Heart
Rate
Data
Sets
get
Height
Measurement
get
Height
Measurements
getMSeries
Challenge
getMSeries
Challenges
getMSeries
Data
Set
getMSeries
Data
Sets
getMSeries
Ftp
Measurement
getMSeries
Ftp
Measurements
get
Machine
Adjustment
get
Machine
Adjustments
getOAuth
Service
getOAuth
Services
get
Primary
Email
Address
get
Session
get
Sessions
get
Strength
Machine
Data
Set
get
Strength
Machine
Data
Sets
get
Strength
Machine
Profile
Stats
get
Weight
Measurement
get
Weight
Measurements
initiateOAuth
Service
joinMSeries
Challenge
reload
start
Session
Constructors
constructor
new
Facility
Employee
User
(
userData
:
UserData
, sessionHandler
:
SessionHandler
, facilityRelationshipId
:
number
)
:
FacilityEmployeeUser
Parameters
userData:
UserData
sessionHandler:
SessionHandler
facilityRelationshipId:
number
Returns
FacilityEmployeeUser
Accessors
basic
Credential
get
basicCredential
(
)
:
boolean
Returns
boolean
facility
Relationship
Id
get
facilityRelationshipId
(
)
:
number
Returns
number
id
get
id
(
)
:
number
Returns
number
on
Model
Change
Event
get
onModelChangeEvent
(
)
:
IEvent
<
ModelChangeEvent
>
Returns
IEvent
<
ModelChangeEvent
>
Methods
add
Basic
Login
add
Basic
Login
(
params
:
{
email
:
string
;
password
:
string
}
)
:
Promise
<
void
>
Parameters
params:
{
email
:
string
;
password
:
string
}
email
:
string
password
:
string
Returns
Promise
<
void
>
change
Password
change
Password
(
params
:
{
password
:
string
}
)
:
Promise
<
void
>
Parameters
params:
{
password
:
string
}
password
:
string
Returns
Promise
<
void
>
create
Accepted
Terms
Version
create
Accepted
Terms
Version
(
params
:
{
revision
:
string
}
)
:
Promise
<
AcceptedTermsVersion
>
Parameters
params:
{
revision
:
string
}
revision
:
string
Returns
Promise
<
AcceptedTermsVersion
>
create
Development
Account
create
Development
Account
(
params
:
{
address
?:
string
;
company
?:
string
;
privacyUrl
:
string
;
termsUrl
:
string
;
websiteUrl
?:
string
}
)
:
Promise
<
DevelopmentAccount
>
Parameters
params:
{
address
?:
string
;
company
?:
string
;
privacyUrl
:
string
;
termsUrl
:
string
;
websiteUrl
?:
string
}
Optional
address
?:
string
Optional
company
?:
string
privacy
Url
:
string
terms
Url
:
string
Optional
website
Url
?:
string
Returns
Promise
<
DevelopmentAccount
>
create
Email
Address
create
Email
Address
(
params
:
{
email
:
string
}
)
:
Promise
<
EmailAddress
>
Parameters
params:
{
email
:
string
}
email
:
string
Returns
Promise
<
EmailAddress
>
create
Heart
Rate
Data
Set
create
Heart
Rate
Data
Set
(
params
:
{
autoAttachSession
?:
boolean
;
heartRateDataPoints
:
HeartRateCapturedDataPoint
[]
;
sessionId
?:
number
;
source
:
string
}
)
:
Promise
<
HeartRateDataSet
>
Parameters
params:
{
autoAttachSession
?:
boolean
;
heartRateDataPoints
:
HeartRateCapturedDataPoint
[]
;
sessionId
?:
number
;
source
:
string
}
Optional
auto
Attach
Session
?:
boolean
heart
Rate
Data
Points
:
HeartRateCapturedDataPoint
[]
Optional
session
Id
?:
number
source
:
string
Returns
Promise
<
HeartRateDataSet
>
create
Height
Measurement
create
Height
Measurement
(
params
:
{
metricHeight
:
number
;
source
:
string
;
takenAt
:
Date
}
)
:
Promise
<
HeightMeasurement
>
Parameters
params:
{
metricHeight
:
number
;
source
:
string
;
takenAt
:
Date
}
metric
Height
:
number
source
:
string
taken
At
:
Date
Returns
Promise
<
HeightMeasurement
>
createMSeries
Challenge
createMSeries
Challenge
(
params
:
{
challengeType
:
MSeriesChallengeType
;
endAt
?:
Date
;
focus
:
MSeriesChallengeFocus
;
goal
?:
number
;
isPublic
:
boolean
;
name
:
string
;
startAt
?:
Date
;
userLimit
:
number
}
)
:
Promise
<
PrivilegedMSeriesChallenge
>
Parameters
params:
{
challengeType
:
MSeriesChallengeType
;
endAt
?:
Date
;
focus
:
MSeriesChallengeFocus
;
goal
?:
number
;
isPublic
:
boolean
;
name
:
string
;
startAt
?:
Date
;
userLimit
:
number
}
challenge
Type
:
MSeriesChallengeType
Optional
end
At
?:
Date
focus
:
MSeriesChallengeFocus
Optional
goal
?:
number
is
Public
:
boolean
name
:
string
Optional
start
At
?:
Date
user
Limit
:
number
Returns
Promise
<
PrivilegedMSeriesChallenge
>
createMSeries
Data
Set
createMSeries
Data
Set
(
params
:
{
autoAttachSession
?:
boolean
;
buildMajor
:
number
;
buildMinor
:
number
;
mSeriesDataPoints
:
MSeriesCapturedDataPoint
[]
;
machineType
:
string
;
ordinalId
:
number
;
sessionId
?:
number
;
source
:
string
}
)
:
Promise
<
MSeriesDataSet
>
Parameters
params:
{
autoAttachSession
?:
boolean
;
buildMajor
:
number
;
buildMinor
:
number
;
mSeriesDataPoints
:
MSeriesCapturedDataPoint
[]
;
machineType
:
string
;
ordinalId
:
number
;
sessionId
?:
number
;
source
:
string
}
Optional
auto
Attach
Session
?:
boolean
build
Major
:
number
build
Minor
:
number
m
Series
Data
Points
:
MSeriesCapturedDataPoint
[]
machine
Type
:
string
ordinal
Id
:
number
Optional
session
Id
?:
number
source
:
string
Returns
Promise
<
MSeriesDataSet
>
createMSeries
Ftp
Measurement
createMSeries
Ftp
Measurement
(
params
:
{
ftp
:
number
;
machineType
:
string
;
source
:
string
;
takenAt
:
Date
}
)
:
Promise
<
MSeriesFtpMeasurement
>
Parameters
params:
{
ftp
:
number
;
machineType
:
string
;
source
:
string
;
takenAt
:
Date
}
ftp
:
number
machine
Type
:
string
source
:
string
taken
At
:
Date
Returns
Promise
<
MSeriesFtpMeasurement
>
create
Machine
Adjustment
create
Machine
Adjustment
(
params
:
{
leftPosition
?:
string
;
model
:
string
;
rightPosition
?:
string
;
seat
?:
string
;
start
?:
string
;
stop
?:
string
}
)
:
Promise
<
MachineAdjustment
>
Parameters
params:
{
leftPosition
?:
string
;
model
:
string
;
rightPosition
?:
string
;
seat
?:
string
;
start
?:
string
;
stop
?:
string
}
Optional
left
Position
?:
string
model
:
string
Optional
right
Position
?:
string
Optional
seat
?:
string
Optional
start
?:
string
Optional
stop
?:
string
Returns
Promise
<
MachineAdjustment
>
create
Strength
Machine
Data
Set
create
Strength
Machine
Data
Set
(
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
}
)
:
Promise
<
StrengthMachineDataSet
>
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
added
Weight
?:
number
Optional
auto
Attach
Session
?:
boolean
Optional
chest
?:
number
completed
At
:
Date
Optional
distance
?:
number
Optional
exercise
Id
?:
number
Optional
facility
Id
?:
number
force
Unit
:
ForceUnit
peak
Power
:
number
repetition
Count
:
number
resistance
:
number
resistance
Precision
:
ResistancePrecision
Optional
rom1
?:
number
Optional
rom2
?:
number
Optional
seat
?:
number
serial
:
string
Optional
session
Id
?:
number
strength
Machine
Id
:
number
version
:
string
work
:
number
Returns
Promise
<
StrengthMachineDataSet
>
create
Weight
Measurement
create
Weight
Measurement
(
params
:
{
bodyFatPercentage
?:
number
;
metricWeight
:
number
;
source
:
string
;
takenAt
:
Date
}
)
:
Promise
<
WeightMeasurement
>
Parameters
params:
{
bodyFatPercentage
?:
number
;
metricWeight
:
number
;
source
:
string
;
takenAt
:
Date
}
Optional
body
Fat
Percentage
?:
number
metric
Weight
:
number
source
:
string
taken
At
:
Date
Returns
Promise
<
WeightMeasurement
>
create
Weight
Measurement
From
InBody
create
Weight
Measurement
From
InBody
(
params
:
{
bodyComp
:
object
}
)
:
Promise
<
WeightMeasurement
>
Parameters
params:
{
bodyComp
:
object
}
body
Comp
:
object
Returns
Promise
<
WeightMeasurement
>
create
Weight
Measurements
From
InBodyCSV
create
Weight
Measurements
From
InBodyCSV
(
params
:
{
bodyCompCSV
:
string
}
)
:
Promise
<
WeightMeasurements
>
Parameters
params:
{
bodyCompCSV
:
string
}
body
CompCSV
:
string
Returns
Promise
<
WeightMeasurements
>
delete
delete
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
eager
Accepted
Terms
Version
eager
Accepted
Terms
Version
(
)
:
undefined
|
AcceptedTermsVersion
Returns
undefined
|
AcceptedTermsVersion
eager
Height
Measurements
eager
Height
Measurements
(
)
:
undefined
|
HeightMeasurement
[]
Returns
undefined
|
HeightMeasurement
[]
eagerOAuth
Services
eagerOAuth
Services
(
)
:
undefined
|
OAuthService
[]
Returns
undefined
|
OAuthService
[]
eager
Primary
Email
Address
eager
Primary
Email
Address
(
)
:
undefined
|
PrimaryEmailAddress
Returns
undefined
|
PrimaryEmailAddress
eager
Profile
eager
Profile
(
)
:
Profile
Returns
Profile
eager
Weight
Measurements
eager
Weight
Measurements
(
)
:
undefined
|
WeightMeasurement
[]
Returns
undefined
|
WeightMeasurement
[]
eject
Data
eject
Data
(
)
:
UserData
Returns
UserData
fulfill
Development
Account
Relationship
Request
fulfill
Development
Account
Relationship
Request
(
params
:
{
code
:
string
;
shouldAuthorize
:
boolean
}
)
:
Promise
<
DevelopmentAccountRelationship
>
Parameters
params:
{
code
:
string
;
shouldAuthorize
:
boolean
}
code
:
string
should
Authorize
:
boolean
Returns
Promise
<
DevelopmentAccountRelationship
>
fulfill
Email
Validation
fulfill
Email
Validation
(
token
:
string
)
:
Promise
<
void
>
Parameters
token:
string
Returns
Promise
<
void
>
get
Development
Account
get
Development
Account
(
params
:
{
id
:
number
}
)
:
Promise
<
DevelopmentAccount
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
DevelopmentAccount
>
get
Development
Account
Relationship
Request
get
Development
Account
Relationship
Request
(
params
:
{
code
?:
string
;
developmentAccountId
?:
number
;
id
?:
number
}
)
:
Promise
<
DevelopmentAccountRelationshipRequest
>
Parameters
params:
{
code
?:
string
;
developmentAccountId
?:
number
;
id
?:
number
}
Optional
code
?:
string
Optional
development
Account
Id
?:
number
Optional
id
?:
number
Returns
Promise
<
DevelopmentAccountRelationshipRequest
>
get
Development
Account
Relationship
Requests
get
Development
Account
Relationship
Requests
(
options
:
{
ascending
?:
boolean
;
company
?:
string
;
developmentAccountId
?:
number
;
email
?:
string
;
limit
?:
number
;
offset
?:
number
;
sort
?:
DevelopmentAccountRelationshipRequestSorting
}
)
:
Promise
<
DevelopmentAccountRelationshipRequests
>
Parameters
options:
{
ascending
?:
boolean
;
company
?:
string
;
developmentAccountId
?:
number
;
email
?:
string
;
limit
?:
number
;
offset
?:
number
;
sort
?:
DevelopmentAccountRelationshipRequestSorting
}
Optional
ascending
?:
boolean
Optional
company
?:
string
Optional
development
Account
Id
?:
number
Optional
email
?:
string
Optional
limit
?:
number
Optional
offset
?:
number
Optional
sort
?:
DevelopmentAccountRelationshipRequestSorting
Returns
Promise
<
DevelopmentAccountRelationshipRequests
>
get
Development
Accounts
get
Development
Accounts
(
options
:
{
ascending
?:
boolean
;
limit
?:
number
;
offset
?:
number
;
sort
?:
DevelopmentAccountSorting
}
)
:
Promise
<
DevelopmentAccounts
>
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
>
get
Email
Addresses
get
Email
Addresses
(
options
?:
{
ascending
?:
boolean
;
email
?:
string
;
limit
?:
number
;
offset
?:
number
;
sort
?:
EmailAddressSorting
}
)
:
Promise
<
EmailAddresses
>
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
>
get
Facility
Employee
Relationship
get
Facility
Employee
Relationship
(
params
:
{
id
:
number
}
)
:
Promise
<
UserFacilityEmployeeRelationship
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
UserFacilityEmployeeRelationship
>
get
Facility
Employment
Relationships
get
Facility
Employment
Relationships
(
options
?:
{
ascending
?:
boolean
;
limit
?:
number
;
name
?:
string
;
offset
?:
number
;
sort
?:
UserFacilityRelationshipSorting
}
)
:
Promise
<
UserFacilityEmployeeRelationships
>
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
>
get
Facility
Membership
Relationship
get
Facility
Membership
Relationship
(
params
:
{
id
:
number
}
)
:
Promise
<
UserFacilityMemberRelationship
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
UserFacilityMemberRelationship
>
get
Facility
Membership
Relationships
get
Facility
Membership
Relationships
(
options
?:
{
ascending
?:
boolean
;
limit
?:
number
;
offset
?:
number
;
sort
?:
UserFacilityRelationshipSorting
}
)
:
Promise
<
UserFacilityMemberRelationships
>
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
>
get
Facility
Relationship
get
Facility
Relationship
(
params
:
{
id
:
number
}
)
:
Promise
<
UserFacilityRelationship
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
UserFacilityRelationship
>
get
Facility
Relationship
Request
get
Facility
Relationship
Request
(
params
:
{
id
:
number
}
)
:
Promise
<
FacilityRelationshipRequest
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
FacilityRelationshipRequest
>
get
Facility
Relationship
Requests
get
Facility
Relationship
Requests
(
options
?:
{
ascending
?:
boolean
;
limit
?:
number
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityRelationshipRequestSorting
}
)
:
Promise
<
FacilityRelationshipRequests
>
Parameters
options:
{
ascending
?:
boolean
;
limit
?:
number
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityRelationshipRequestSorting
}
= {}
Optional
ascending
?:
boolean
Optional
limit
?:
number
Optional
member
Identifier
?:
string
Optional
name
?:
string
Optional
offset
?:
number
Optional
sort
?:
FacilityRelationshipRequestSorting
Returns
Promise
<
FacilityRelationshipRequests
>
get
Global
Access
Control
get
Global
Access
Control
(
)
:
Promise
<
GlobalAccessControl
>
Returns
Promise
<
GlobalAccessControl
>
get
Heart
Rate
Data
Set
get
Heart
Rate
Data
Set
(
params
:
{
id
:
number
}
)
:
Promise
<
HeartRateDataSet
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
HeartRateDataSet
>
get
Heart
Rate
Data
Sets
get
Heart
Rate
Data
Sets
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
offset
?:
number
;
sort
?:
HeartRateDataSetSorting
;
source
?:
string
;
to
?:
Date
}
)
:
Promise
<
HeartRateDataSets
>
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
>
get
Height
Measurement
get
Height
Measurement
(
params
:
{
id
:
number
}
)
:
Promise
<
HeightMeasurement
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
HeightMeasurement
>
get
Height
Measurements
get
Height
Measurements
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
offset
?:
number
;
sort
?:
HeightMeasurementSorting
;
to
?:
Date
}
)
:
Promise
<
HeightMeasurements
>
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
>
getMSeries
Challenge
getMSeries
Challenge
(
params
:
(
Without
<
{
id
:
number
}
,
{
joinCode
:
string
}
>
&
{
joinCode
:
string
}
)
|
(
Without
<
{
joinCode
:
string
}
,
{
id
:
number
}
>
&
{
id
:
number
}
)
)
:
Promise
<
JoinableMSeriesChallenge
|
JoinedMSeriesChallenge
|
PrivilegedMSeriesChallenge
>
Parameters
params:
(
Without
<
{
id
:
number
}
,
{
joinCode
:
string
}
>
&
{
joinCode
:
string
}
)
|
(
Without
<
{
joinCode
:
string
}
,
{
id
:
number
}
>
&
{
id
:
number
}
)
Returns
Promise
<
JoinableMSeriesChallenge
|
JoinedMSeriesChallenge
|
PrivilegedMSeriesChallenge
>
getMSeries
Challenges
getMSeries
Challenges
(
params
?:
{
ascending
?:
boolean
;
from
?:
Date
;
isCompleted
?:
boolean
;
limit
?:
number
;
offset
?:
number
;
relationship
?:
MSeriesChallengeRelationship
;
sort
?:
MSeriesChallengeSorting
;
to
?:
Date
}
)
:
Promise
<
JoinedMSeriesChallenges
|
PrivilegedMSeriesChallenges
>
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
is
Completed
?:
boolean
Optional
limit
?:
number
Optional
offset
?:
number
Optional
relationship
?:
MSeriesChallengeRelationship
Optional
sort
?:
MSeriesChallengeSorting
Optional
to
?:
Date
Returns
Promise
<
JoinedMSeriesChallenges
|
PrivilegedMSeriesChallenges
>
getMSeries
Data
Set
getMSeries
Data
Set
(
params
:
{
graphResolution
?:
number
;
id
:
number
}
)
:
Promise
<
MSeriesDataSet
>
Parameters
params:
{
graphResolution
?:
number
;
id
:
number
}
Optional
graph
Resolution
?:
number
id
:
number
Returns
Promise
<
MSeriesDataSet
>
getMSeries
Data
Sets
getMSeries
Data
Sets
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
offset
?:
number
;
sort
?:
MSeriesDataSetSorting
;
source
?:
string
;
to
?:
Date
}
)
:
Promise
<
MSeriesDataSets
>
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
>
getMSeries
Ftp
Measurement
getMSeries
Ftp
Measurement
(
params
:
{
id
:
number
}
)
:
Promise
<
MSeriesFtpMeasurement
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
MSeriesFtpMeasurement
>
getMSeries
Ftp
Measurements
getMSeries
Ftp
Measurements
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
machineType
?:
string
;
offset
?:
number
;
sort
?:
MSeriesFtpMeasurementSorting
;
source
?:
string
;
to
?:
Date
}
)
:
Promise
<
MSeriesFtpMeasurements
>
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
machine
Type
?:
string
Optional
offset
?:
number
Optional
sort
?:
MSeriesFtpMeasurementSorting
Optional
source
?:
string
Optional
to
?:
Date
Returns
Promise
<
MSeriesFtpMeasurements
>
get
Machine
Adjustment
get
Machine
Adjustment
(
params
:
{
id
:
number
}
)
:
Promise
<
MachineAdjustment
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
MachineAdjustment
>
get
Machine
Adjustments
get
Machine
Adjustments
(
options
:
{
ascending
?:
boolean
;
limit
?:
number
;
model
?:
string
;
offset
?:
number
;
sort
?:
ID
}
)
:
Promise
<
MachineAdjustments
>
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
>
getOAuth
Service
getOAuth
Service
(
params
:
{
id
:
number
}
)
:
Promise
<
OAuthService
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
OAuthService
>
getOAuth
Services
getOAuth
Services
(
options
?:
{
limit
?:
number
;
offset
?:
number
;
service
?:
OAuthProviders
}
)
:
Promise
<
OAuthServices
>
Parameters
options:
{
limit
?:
number
;
offset
?:
number
;
service
?:
OAuthProviders
}
= {}
Optional
limit
?:
number
Optional
offset
?:
number
Optional
service
?:
OAuthProviders
Returns
Promise
<
OAuthServices
>
get
Primary
Email
Address
get
Primary
Email
Address
(
)
:
Promise
<
PrimaryEmailAddress
>
Returns
Promise
<
PrimaryEmailAddress
>
get
Session
get
Session
(
params
:
{
id
:
number
}
)
:
Promise
<
Session
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
Session
>
get
Sessions
get
Sessions
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
offset
?:
number
;
open
?:
boolean
;
requireExtendedDataType
?:
SessionRequireExtendedDataType
;
sort
?:
SessionSorting
;
to
?:
Date
}
)
:
Promise
<
Sessions
>
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
require
Extended
Data
Type
?:
SessionRequireExtendedDataType
Optional
sort
?:
SessionSorting
Optional
to
?:
Date
Returns
Promise
<
Sessions
>
get
Strength
Machine
Data
Set
get
Strength
Machine
Data
Set
(
params
:
{
id
:
number
}
)
:
Promise
<
StrengthMachineDataSet
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
StrengthMachineDataSet
>
get
Strength
Machine
Data
Sets
get
Strength
Machine
Data
Sets
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
offset
?:
number
;
sort
?:
StrengthMachineDataSetSorting
;
strengthMachineId
?:
number
;
to
?:
Date
}
)
:
Promise
<
StrengthMachineDataSets
>
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
strength
Machine
Id
?:
number
Optional
to
?:
Date
Returns
Promise
<
StrengthMachineDataSets
>
get
Strength
Machine
Profile
Stats
get
Strength
Machine
Profile
Stats
(
params
:
{
strengthMachineId
:
number
}
)
:
Promise
<
StrengthMachineProfileStats
>
Parameters
params:
{
strengthMachineId
:
number
}
strength
Machine
Id
:
number
Returns
Promise
<
StrengthMachineProfileStats
>
get
Weight
Measurement
get
Weight
Measurement
(
params
:
{
id
:
number
}
)
:
Promise
<
WeightMeasurement
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
WeightMeasurement
>
get
Weight
Measurements
get
Weight
Measurements
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
offset
?:
number
;
sort
?:
WeightMeasurementSorting
;
to
?:
Date
}
)
:
Promise
<
WeightMeasurements
>
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
>
initiateOAuth
Service
initiateOAuth
Service
(
params
:
{
redirect
:
string
;
service
:
OAuthProviders
}
)
:
Promise
<
{
redirectUrl
:
string
}
>
Parameters
params:
{
redirect
:
string
;
service
:
OAuthProviders
}
redirect
:
string
service
:
OAuthProviders
Returns
Promise
<
{
redirectUrl
:
string
}
>
joinMSeries
Challenge
joinMSeries
Challenge
(
params
:
{
joinCode
:
string
}
)
:
Promise
<
MSeriesChallengeParticipant
>
Parameters
params:
{
joinCode
:
string
}
join
Code
:
string
Returns
Promise
<
MSeriesChallengeParticipant
>
reload
reload
(
)
:
Promise
<
FacilityEmployeeUser
>
Returns
Promise
<
FacilityEmployeeUser
>
start
Session
start
Session
(
params
?:
{
continueFromLastSet
?:
boolean
;
forceEndPrevious
?:
boolean
;
sessionPlanSequenceAssignmentId
?:
number
}
)
:
Promise
<
{
session
:
Session
}
>
Parameters
params:
{
continueFromLastSet
?:
boolean
;
forceEndPrevious
?:
boolean
;
sessionPlanSequenceAssignmentId
?:
number
}
= {}
Optional
continue
From
Last
Set
?:
boolean
Optional
force
End
Previous
?:
boolean
Optional
session
Plan
Sequence
Assignment
Id
?:
number
Returns
Promise
<
{
session
:
Session
}
>
Modules
models/user
Facility
Employee
User
constructor
basic
Credential
facility
Relationship
Id
id
on
Model
Change
Event
add
Basic
Login
change
Password
create
Accepted
Terms
Version
create
Development
Account
create
Email
Address
create
Heart
Rate
Data
Set
create
Height
Measurement
createMSeries
Challenge
createMSeries
Data
Set
createMSeries
Ftp
Measurement
create
Machine
Adjustment
create
Strength
Machine
Data
Set
create
Weight
Measurement
create
Weight
Measurement
From
InBody
create
Weight
Measurements
From
InBodyCSV
delete
eager
Accepted
Terms
Version
eager
Height
Measurements
eagerOAuth
Services
eager
Primary
Email
Address
eager
Profile
eager
Weight
Measurements
eject
Data
fulfill
Development
Account
Relationship
Request
fulfill
Email
Validation
get
Development
Account
get
Development
Account
Relationship
Request
get
Development
Account
Relationship
Requests
get
Development
Accounts
get
Email
Addresses
get
Facility
Employee
Relationship
get
Facility
Employment
Relationships
get
Facility
Membership
Relationship
get
Facility
Membership
Relationships
get
Facility
Relationship
get
Facility
Relationship
Request
get
Facility
Relationship
Requests
get
Global
Access
Control
get
Heart
Rate
Data
Set
get
Heart
Rate
Data
Sets
get
Height
Measurement
get
Height
Measurements
getMSeries
Challenge
getMSeries
Challenges
getMSeries
Data
Set
getMSeries
Data
Sets
getMSeries
Ftp
Measurement
getMSeries
Ftp
Measurements
get
Machine
Adjustment
get
Machine
Adjustments
getOAuth
Service
getOAuth
Services
get
Primary
Email
Address
get
Session
get
Sessions
get
Strength
Machine
Data
Set
get
Strength
Machine
Data
Sets
get
Strength
Machine
Profile
Stats
get
Weight
Measurement
get
Weight
Measurements
initiateOAuth
Service
joinMSeries
Challenge
reload
start
Session
Facility
Member
User
Facility
User
User
Exchangeable
User
Response
Facility
User
Response
OAuth
Connect
Response
User
Data
User
Response