default | /src/Oura.ts | oura_api@0.4.0

class default

import { default } from "https://deno.land/x/oura_api@0.4.0/src/Oura.ts";

Constructors

new

default(accessToken: string)

Creates a new Oura API client.

Methods

getDailyActivity(documentId: string): Promise<DailyActivity>

Retrieves a single activity document by its ID.

getDailyActivityDocuments(startDate: DateFormat, endDate: DateFormat): Promise<DailyActivityDocuments>

Retrieves daily activity documents for a specified date range.

getDailyReadiness(documentId: string): Promise<DailyReadiness>

Retrieves a single readiness document by its ID.

getDailyReadinessDocuments(startDate: DateFormat, endDate: DateFormat): Promise<DailyReadinessDocuments>

Retrieves daily readiness documents for a specified date range.

getDailySession(documentId: string): Promise<DailySession>

Retrieves a single daily session document by its ID.

getDailySessionDocuments(startDate: DateFormat, endDate: DateFormat): Promise<DailySessionDocuments>

Retrieves daily session documents for a specified date range.

getDailySleep(documentId: string): Promise<DailySleep>

Retrieves a single daily sleep document by its ID.

getDailySleepDocuments(startDate: DateFormat, endDate: DateFormat): Promise<DailySleepDocuments>

Retrieves daily sleep documents for a specified date range.

getDailySpo2(documentId: string): Promise<DailySpo2>

Retrieves a single daily spO2 (blood oxygenation) average document by its ID.

getDailySpo2Documents(startDate: DateFormat, endDate: DateFormat): Promise<DailySpo2Documents>

Retrieves daily spO2 (blood oxygenation) averages for a specified date range.

getEnhancedTag(documentId: string): Promise<EnhancedTag>

Retrieves a single enhanced tags document by its ID.

getEnhancedTagDocuments(startDate: DateFormat, endDate: DateFormat): Promise<EnhancedTagDocuments>

Retrieves enhanced tags for a specified date range.

getHeartrate(startDateTime: string, endDateTime: string): Promise<Heartrate>

Retrieves heart rate data for a specified date and time period.

getPersonalInfo(): Promise<PersonalInfo>

Retrieves personal information about the user.

getRestModePeriod(documentId: string): Promise<RestModePeriod>

Retrieves a single rest mode period document by its ID.

getRestModePeriodDocuments(startDate: DateFormat, endDate: DateFormat): Promise<RestModePeriodDocuments>

Retrieves rest mode periods for a specified date range.

getRingConfiguration(documentId: string): Promise<RingConfiguration>

Retrieves a single ring configuration document by its ID.

getRingConfigurationDocuments(startDate: DateFormat, endDate: DateFormat): Promise<RingConfigurationDocuments>

Retrieves ring configuration information for a specified date range.

getSleep(documentId: string): Promise<Sleep>

Retrieves a single sleep session document by its ID.

getSleepDocuments(startDate: DateFormat, endDate: DateFormat): Promise<SleepDocuments>

Retrieves sleep documents for a specified date range.

getSleepTime(documentId: string): Promise<SleepTime>

Retrieves a single recommended bedtime window document by its ID.

getSleepTimeDocuments(startDate: DateFormat, endDate: DateFormat): Promise<SleepTimeDocuments>

Retrieves recommended bedtime windows for a specified date range.

getTag(documentId: string): Promise<Tag>

Retrieves a single tag document by its ID.

Note: Tag is deprecated. We recommend transitioning to Enhanced Tag.

getTagDocuments(startDate: DateFormat, endDate: DateFormat): Promise<TagDocuments>

Retrieves daily tags for a specified date range.

Note: Tag is deprecated. We recommend transitioning to Enhanced Tag.

getWorkout(documentId: string): Promise<Workout>

Retrieves a single workout document by its ID.

getWorkoutDocuments(startDate: DateFormat, endDate: DateFormat): Promise<WorkoutDocuments>

Retrieves workout documents for a specified date range.