Class FlowApiClient

Hierarchy

FlowApiClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FlowApiClient(): FlowApiClient

- Defined in flow-api-client.ts:20
Returns FlowApiClient

Properties

Private cookieJar

cookieJar: request.CookieJar = request.jar()

Private mUserAgent

mUserAgent: string = "Mozilla/5.0"

Private requestClient

requestClient: requestPromise.RequestPromiseAPI

Accessors

jar

get jar(): request.CookieJar

- Defined in flow-api-client.ts:31
Returns request.CookieJar

userAgent

get userAgent(): string
set userAgent(useragent: string): void

- Defined in flow-api-client.ts:35
Returns string
- Defined in flow-api-client.ts:39
Parameters
- useragent: string
Returns void

Methods

createBaseUrl

createBaseUrl(): URL

- Defined in flow-api-client.ts:95
Returns URL

get

get<T>(queryUrl: URL): Promise<T>

- Defined in flow-api-client.ts:111
Executes a get request

Type parameters
- T
Parameters
- queryUrl: URL
Returns Promise<T>

getActivityTimelineForDay

getActivityTimelineForDay(date: FlowDate, sampleCount?: number): Promise<IDaySummary>

- Defined in flow-api-client.ts:99
Parameters
- date: FlowDate
- Default value sampleCount: number = 50000
Returns Promise<IDaySummary>

getHistory

getHistory(from: FlowDate, to: FlowDate, userId: any, types?: number[]): Promise<IHistoryItem[]>

- Defined in flow-api-client.ts:83
Parameters
- from: FlowDate
- to: FlowDate
- userId: any
- Optional types: number[]
Returns Promise<IHistoryItem[]>

getSleep

getSleep(id: number | string): Promise<ISleepInterval[]>

- Defined in flow-api-client.ts:66
Parameters
- id: number | string
Returns Promise<ISleepInterval[]>

getSleepNearby

getSleepNearby(date: FlowDate): Promise<ISleepNearby>

- Defined in flow-api-client.ts:72
Parameters
- date: FlowDate
Returns Promise<ISleepNearby>

getSleepReport

getSleepReport(from: FlowDate, to: FlowDate): Promise<ISleepReport[]>

- Defined in flow-api-client.ts:79
Parameters
- from: FlowDate
- to: FlowDate
Returns Promise<ISleepReport[]>

post

post<T, B>(queryUrl: URL, body: B): Promise<T>

- Defined in flow-api-client.ts:119
Executes a post request

Type parameters
- T
- B
Parameters
- queryUrl: URL
- body: B
  
  body to send
Returns Promise<T>

signin

signin(mail: string, password: string): Promise<request.Response>

- Defined in flow-api-client.ts:48
Parameters
- mail: string
  
  The mail used to login to flow.polar.com
- password: string
  
  the password used to login to flow.polar.com
Returns Promise<request.Response>

Generated using TypeDoc