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/facility
PrivilegedFacility
Class PrivilegedFacility
Hierarchy
Facility
PrivilegedFacility
Index
Constructors
constructor
Accessors
id
is
Active
licensed
Until
on
Model
Change
Event
Methods
apply
License
create
Facility
Employee
User
create
Facility
Initiated
Relationship
Request
create
Facility
Member
User
create
Facility
Strength
Machine
create
Facility
Strength
Machines
FromEChip
create
Kiosk
Session
create
User
Initiated
Relationship
Request
eager
Facility
Profile
eject
Data
get
Access
Control
get
Configuration
get
Employee
Relationship
get
Employee
Relationships
get
Export
Csv
get
Facility
Report
Check
In
get
Facility
Strength
Machine
get
Facility
Strength
Machine
Configuration
get
Facility
Strength
Machine
InitializerJWTToken
get
Facility
Strength
Machine
InitializerOTPToken
get
Facility
Strength
Machines
get
Member
Relationship
get
Member
Relationships
get
Relationship
get
Relationship
Request
get
Relationship
Requests
get
Relationships
get
Session
get
Sessions
reload
set
Active
Constructors
constructor
new
Privileged
Facility
(
facilityData
:
FacilityData
, sessionHandler
:
SessionHandler
)
:
PrivilegedFacility
Parameters
facilityData:
FacilityData
sessionHandler:
SessionHandler
Returns
PrivilegedFacility
Accessors
id
get
id
(
)
:
number
Returns
number
is
Active
get
isActive
(
)
:
boolean
Returns
boolean
licensed
Until
get
licensedUntil
(
)
:
Date
Returns
Date
on
Model
Change
Event
get
onModelChangeEvent
(
)
:
IEvent
<
ModelChangeEvent
>
Returns
IEvent
<
ModelChangeEvent
>
Methods
apply
License
apply
License
(
params
:
{
key
:
string
}
)
:
Promise
<
PrivilegedFacility
>
Parameters
params:
{
key
:
string
}
key
:
string
Returns
Promise
<
PrivilegedFacility
>
create
Facility
Employee
User
create
Facility
Employee
User
(
params
:
{
birthday
?:
Date
;
email
:
string
;
employeeRole
:
string
;
gender
?:
Gender
;
language
?:
string
;
member
?:
boolean
;
memberIdentifier
?:
string
;
memberSecret
?:
string
;
name
:
string
;
units
?:
Units
}
)
:
Promise
<
FacilityUserEmployeeRelationship
>
Parameters
params:
{
birthday
?:
Date
;
email
:
string
;
employeeRole
:
string
;
gender
?:
Gender
;
language
?:
string
;
member
?:
boolean
;
memberIdentifier
?:
string
;
memberSecret
?:
string
;
name
:
string
;
units
?:
Units
}
Optional
birthday
?:
Date
email
:
string
employee
Role
:
string
Optional
gender
?:
Gender
Optional
language
?:
string
Optional
member
?:
boolean
Optional
member
Identifier
?:
string
Optional
member
Secret
?:
string
name
:
string
Optional
units
?:
Units
Returns
Promise
<
FacilityUserEmployeeRelationship
>
create
Facility
Initiated
Relationship
Request
create
Facility
Initiated
Relationship
Request
(
params
:
{
email
:
string
;
employeeRole
?:
null
|
FacilityEmployeeRole
;
member
?:
boolean
;
memberIdentifier
?:
string
}
)
:
Promise
<
PrivilegedFacilityRelationshipRequest
>
Parameters
params:
{
email
:
string
;
employeeRole
?:
null
|
FacilityEmployeeRole
;
member
?:
boolean
;
memberIdentifier
?:
string
}
email
:
string
Optional
employee
Role
?:
null
|
FacilityEmployeeRole
Optional
member
?:
boolean
Optional
member
Identifier
?:
string
Returns
Promise
<
PrivilegedFacilityRelationshipRequest
>
create
Facility
Member
User
create
Facility
Member
User
(
params
:
{
birthday
?:
Date
;
email
:
string
;
employeeRole
?:
null
|
string
;
gender
?:
Gender
;
language
?:
string
;
memberIdentifier
?:
string
;
memberSecret
?:
string
;
name
:
string
;
units
?:
Units
}
)
:
Promise
<
FacilityUserMemberRelationship
>
Parameters
params:
{
birthday
?:
Date
;
email
:
string
;
employeeRole
?:
null
|
string
;
gender
?:
Gender
;
language
?:
string
;
memberIdentifier
?:
string
;
memberSecret
?:
string
;
name
:
string
;
units
?:
Units
}
Optional
birthday
?:
Date
email
:
string
Optional
employee
Role
?:
null
|
string
Optional
gender
?:
Gender
Optional
language
?:
string
Optional
member
Identifier
?:
string
Optional
member
Secret
?:
string
name
:
string
Optional
units
?:
Units
Returns
Promise
<
FacilityUserMemberRelationship
>
create
Facility
Strength
Machine
create
Facility
Strength
Machine
(
params
:
{
location
?:
string
;
model
:
string
;
serial
:
string
;
strengthMachineId
:
number
;
version
:
string
}
)
:
Promise
<
FacilityStrengthMachine
>
Parameters
params:
{
location
?:
string
;
model
:
string
;
serial
:
string
;
strengthMachineId
:
number
;
version
:
string
}
Optional
location
?:
string
model
:
string
serial
:
string
strength
Machine
Id
:
number
version
:
string
Returns
Promise
<
FacilityStrengthMachine
>
create
Facility
Strength
Machines
FromEChip
create
Facility
Strength
Machines
FromEChip
(
params
:
{
echipData
:
any
}
)
:
Promise
<
{
strengthMachines
:
FacilityStrengthMachine
[]
;
unknownMachines
:
FacilityStrengthMachineData
[]
}
>
Parameters
params:
{
echipData
:
any
}
echip
Data
:
any
Returns
Promise
<
{
strengthMachines
:
FacilityStrengthMachine
[]
;
unknownMachines
:
FacilityStrengthMachineData
[]
}
>
create
Kiosk
Session
create
Kiosk
Session
(
)
:
Promise
<
KioskSession
>
Returns
Promise
<
KioskSession
>
create
User
Initiated
Relationship
Request
create
User
Initiated
Relationship
Request
(
params
:
{
memberIdentifier
?:
string
}
)
:
Promise
<
FacilityRelationshipRequest
>
Parameters
params:
{
memberIdentifier
?:
string
}
Optional
member
Identifier
?:
string
Returns
Promise
<
FacilityRelationshipRequest
>
eager
Facility
Profile
eager
Facility
Profile
(
)
:
undefined
|
PrivilegedFacilityProfile
Returns
undefined
|
PrivilegedFacilityProfile
eject
Data
eject
Data
(
)
:
FacilityData
Returns
FacilityData
get
Access
Control
get
Access
Control
(
)
:
Promise
<
FacilityAccessControl
>
Returns
Promise
<
FacilityAccessControl
>
get
Configuration
get
Configuration
(
)
:
Promise
<
FacilityConfiguration
>
Returns
Promise
<
FacilityConfiguration
>
get
Employee
Relationship
get
Employee
Relationship
(
params
:
{
id
:
number
}
)
:
Promise
<
FacilityUserEmployeeRelationship
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
FacilityUserEmployeeRelationship
>
get
Employee
Relationships
get
Employee
Relationships
(
options
?:
{
ascending
?:
boolean
;
employeeRole
?:
null
|
FacilityEmployeeRole
;
limit
?:
number
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityUserRelationshipSorting
}
)
:
Promise
<
FacilityUserEmployeeRelationships
>
Parameters
options:
{
ascending
?:
boolean
;
employeeRole
?:
null
|
FacilityEmployeeRole
;
limit
?:
number
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityUserRelationshipSorting
}
= {}
Optional
ascending
?:
boolean
Optional
employee
Role
?:
null
|
FacilityEmployeeRole
Optional
limit
?:
number
Optional
name
?:
string
Optional
offset
?:
number
Optional
sort
?:
FacilityUserRelationshipSorting
Returns
Promise
<
FacilityUserEmployeeRelationships
>
get
Export
Csv
get
Export
Csv
(
params
:
{
from
:
Date
;
to
:
Date
}
)
:
string
Parameters
params:
{
from
:
Date
;
to
:
Date
}
from
:
Date
to
:
Date
Returns
string
get
Facility
Report
Check
In
get
Facility
Report
Check
In
(
params
:
{
from
:
Date
;
group
:
ReportGrouping
;
to
:
Date
}
)
:
string
Parameters
params:
{
from
:
Date
;
group
:
ReportGrouping
;
to
:
Date
}
from
:
Date
group
:
ReportGrouping
to
:
Date
Returns
string
get
Facility
Strength
Machine
get
Facility
Strength
Machine
(
params
:
{
id
:
number
}
)
:
Promise
<
FacilityStrengthMachine
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
FacilityStrengthMachine
>
get
Facility
Strength
Machine
Configuration
get
Facility
Strength
Machine
Configuration
(
)
:
Promise
<
FacilityStrengthMachineConfiguration
>
Returns
Promise
<
FacilityStrengthMachineConfiguration
>
get
Facility
Strength
Machine
InitializerJWTToken
get
Facility
Strength
Machine
InitializerJWTToken
(
)
:
Promise
<
MachineInitializerToken
>
Returns
Promise
<
MachineInitializerToken
>
get
Facility
Strength
Machine
InitializerOTPToken
get
Facility
Strength
Machine
InitializerOTPToken
(
)
:
Promise
<
MachineInitializerOTPToken
>
Returns
Promise
<
MachineInitializerOTPToken
>
get
Facility
Strength
Machines
get
Facility
Strength
Machines
(
options
?:
{
ascending
?:
boolean
;
limit
?:
number
;
model
?:
string
;
offset
?:
number
;
sort
?:
FacilityStrengthMachineSorting
}
)
:
Promise
<
FacilityStrengthMachines
>
Parameters
options:
{
ascending
?:
boolean
;
limit
?:
number
;
model
?:
string
;
offset
?:
number
;
sort
?:
FacilityStrengthMachineSorting
}
= {}
Optional
ascending
?:
boolean
Optional
limit
?:
number
Optional
model
?:
string
Optional
offset
?:
number
Optional
sort
?:
FacilityStrengthMachineSorting
Returns
Promise
<
FacilityStrengthMachines
>
get
Member
Relationship
get
Member
Relationship
(
params
:
{
id
:
number
}
)
:
Promise
<
FacilityUserMemberRelationship
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
FacilityUserMemberRelationship
>
get
Member
Relationships
get
Member
Relationships
(
options
?:
{
ascending
?:
boolean
;
includeSession
?:
boolean
;
limit
?:
number
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityUserRelationshipSorting
}
)
:
Promise
<
FacilityUserMemberRelationships
>
Parameters
options:
{
ascending
?:
boolean
;
includeSession
?:
boolean
;
limit
?:
number
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityUserRelationshipSorting
}
= {}
Optional
ascending
?:
boolean
Optional
include
Session
?:
boolean
Optional
limit
?:
number
Optional
member
Identifier
?:
string
Optional
name
?:
string
Optional
offset
?:
number
Optional
sort
?:
FacilityUserRelationshipSorting
Returns
Promise
<
FacilityUserMemberRelationships
>
get
Relationship
get
Relationship
(
params
:
{
id
:
number
}
)
:
Promise
<
FacilityUserRelationship
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
FacilityUserRelationship
>
get
Relationship
Request
get
Relationship
Request
(
params
:
{
id
:
number
}
)
:
Promise
<
PrivilegedFacilityRelationshipRequest
>
Parameters
params:
{
id
:
number
}
id
:
number
Returns
Promise
<
PrivilegedFacilityRelationshipRequest
>
get
Relationship
Requests
get
Relationship
Requests
(
options
?:
{
ascending
?:
boolean
;
limit
?:
number
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
PrivilegedFacilityRelationshipRequestSorting
}
)
:
Promise
<
PrivilegedFacilityRelationshipRequests
>
Parameters
options:
{
ascending
?:
boolean
;
limit
?:
number
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
PrivilegedFacilityRelationshipRequestSorting
}
= {}
Optional
ascending
?:
boolean
Optional
limit
?:
number
Optional
member
Identifier
?:
string
Optional
name
?:
string
Optional
offset
?:
number
Optional
sort
?:
PrivilegedFacilityRelationshipRequestSorting
Returns
Promise
<
PrivilegedFacilityRelationshipRequests
>
get
Relationships
get
Relationships
(
options
?:
{
ascending
?:
boolean
;
employee
?:
boolean
;
includeSession
?:
boolean
;
limit
?:
number
;
member
?:
boolean
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityUserRelationshipSorting
}
)
:
Promise
<
FacilityUserRelationships
>
Parameters
options:
{
ascending
?:
boolean
;
employee
?:
boolean
;
includeSession
?:
boolean
;
limit
?:
number
;
member
?:
boolean
;
memberIdentifier
?:
string
;
name
?:
string
;
offset
?:
number
;
sort
?:
FacilityUserRelationshipSorting
}
= {}
Optional
ascending
?:
boolean
Optional
employee
?:
boolean
Optional
include
Session
?:
boolean
Optional
limit
?:
number
Optional
member
?:
boolean
Optional
member
Identifier
?:
string
Optional
name
?:
string
Optional
offset
?:
number
Optional
sort
?:
FacilityUserRelationshipSorting
Returns
Promise
<
FacilityUserRelationships
>
get
Session
get
Session
(
params
:
(
Without
<
{
id
:
number
}
,
{
echipId
:
string
}
>
&
{
echipId
:
string
}
)
|
(
Without
<
{
echipId
:
string
}
,
{
id
:
number
}
>
&
{
id
:
number
}
)
)
:
Promise
<
FacilitySession
>
Parameters
params:
(
Without
<
{
id
:
number
}
,
{
echipId
:
string
}
>
&
{
echipId
:
string
}
)
|
(
Without
<
{
echipId
:
string
}
,
{
id
:
number
}
>
&
{
id
:
number
}
)
Returns
Promise
<
FacilitySession
>
get
Sessions
get
Sessions
(
options
?:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
name
?:
string
;
offset
?:
number
;
open
?:
boolean
;
sort
?:
SessionSorting
;
to
?:
Date
}
)
:
Promise
<
FacilitySessions
>
Parameters
options:
{
ascending
?:
boolean
;
from
?:
Date
;
limit
?:
number
;
name
?:
string
;
offset
?:
number
;
open
?:
boolean
;
sort
?:
SessionSorting
;
to
?:
Date
}
= {}
Optional
ascending
?:
boolean
Optional
from
?:
Date
Optional
limit
?:
number
Optional
name
?:
string
Optional
offset
?:
number
Optional
open
?:
boolean
Optional
sort
?:
SessionSorting
Optional
to
?:
Date
Returns
Promise
<
FacilitySessions
>
reload
reload
(
)
:
Promise
<
PrivilegedFacility
>
Returns
Promise
<
PrivilegedFacility
>
set
Active
set
Active
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Modules
models/facility
Facility
Sorting
Facilities
Facility
Privileged
Facility
constructor
id
is
Active
licensed
Until
on
Model
Change
Event
apply
License
create
Facility
Employee
User
create
Facility
Initiated
Relationship
Request
create
Facility
Member
User
create
Facility
Strength
Machine
create
Facility
Strength
Machines
FromEChip
create
Kiosk
Session
create
User
Initiated
Relationship
Request
eager
Facility
Profile
eject
Data
get
Access
Control
get
Configuration
get
Employee
Relationship
get
Employee
Relationships
get
Export
Csv
get
Facility
Report
Check
In
get
Facility
Strength
Machine
get
Facility
Strength
Machine
Configuration
get
Facility
Strength
Machine
InitializerJWTToken
get
Facility
Strength
Machine
InitializerOTPToken
get
Facility
Strength
Machines
get
Member
Relationship
get
Member
Relationships
get
Relationship
get
Relationship
Request
get
Relationship
Requests
get
Relationships
get
Session
get
Sessions
reload
set
Active
Facility
Data
Facility
List
Response
Facility
List
Response
Meta
Facility
Response