# Reference
## Link
client.link.listBulkOps({ ...params }) -> Vital.BulkOpsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.link.listBulkOps({
nextCursor: "next_cursor",
pageSize: 1,
teamId: "infer_from_context"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LinkListBulkOpsRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.bulkImport({ ...params }) -> Vital.BulkImportConnectionsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.link.bulkImport({
teamId: "infer_from_context",
provider: "oura",
connections: [{
userId: "user_id",
accessToken: "access_token",
refreshToken: "refresh_token",
providerId: "provider_id",
expiresAt: 1
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.BulkImportConnectionsBody`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.bulkTriggerHistoricalPull({ ...params }) -> unknown
-
#### 🔌 Usage
-
-
```typescript
await client.link.bulkTriggerHistoricalPull({
teamId: "infer_from_context",
userIds: ["user_ids"],
provider: "oura"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.BulkTriggerHistoricalPullBody`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.bulkExport({ ...params }) -> Vital.BulkExportConnectionsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.link.bulkExport({
teamId: "infer_from_context",
provider: "oura"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.BulkExportConnectionsBody`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.bulkPause({ ...params }) -> unknown
-
#### 🔌 Usage
-
-
```typescript
await client.link.bulkPause({
teamId: "infer_from_context",
userIds: ["user_ids"],
provider: "oura"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.BulkPauseConnectionsBody`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.token({ ...params }) -> Vital.LinkTokenExchangeResponse
-
#### 📝 Description
-
-
Endpoint to generate a user link token, to be used throughout the vital
link process. The vital link token is a one time use token, that
expires after 10 minutes. If you would like vital-link widget to launch
with a specific provider, pass in a provider in the body. If you would
like to redirect to a custom url after successful or error connection,
pass in your own custom redirect_url parameter.
#### 🔌 Usage
-
-
```typescript
await client.link.token({
userId: "user_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LinkTokenExchange`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.isTokenValid({ ...params }) -> Record
-
#### 🔌 Usage
-
-
```typescript
await client.link.isTokenValid({
token: "token"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LinkTokenValidationRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.codeCreate({ ...params }) -> Vital.VitalTokenCreatedResponse
-
#### 📝 Description
-
-
Generate a token to invite a user of Vital mobile app to your team
#### 🔌 Usage
-
-
```typescript
await client.link.codeCreate({
userId: "user_id",
expiresAt: new Date("2024-01-15T09:30:00.000Z")
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LinkCodeCreateRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.startConnect({ ...params }) -> Record
-
#### 📝 Description
-
-
REQUEST_SOURCE: VITAL-LINK
Start link token process
#### 🔌 Usage
-
-
```typescript
await client.link.startConnect({
linkToken: "link_token",
provider: "oura"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.BeginLinkTokenRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.tokenState({ ...params }) -> Record
-
#### 📝 Description
-
-
REQUEST_SOURCE: VITAL-LINK
Check link token state - can be hit continuously used as heartbeat
#### 🔌 Usage
-
-
```typescript
await client.link.tokenState({
vitalLinkToken: "x-vital-link-token"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LinkTokenStateRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.emailAuth({ ...params }) -> unknown
-
#### 📝 Description
-
-
Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
#### 🔌 Usage
-
-
```typescript
await client.link.emailAuth({
vitalLinkToken: "x-vital-link-token",
email: "email",
provider: "oura",
authType: "password"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.EmailAuthLink`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.passwordAuth({ ...params }) -> unknown
-
#### 📝 Description
-
-
Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
#### 🔌 Usage
-
-
```typescript
await client.link.passwordAuth({
vitalLinkToken: "x-vital-link-token",
username: "username",
password: "password",
provider: "oura",
authType: "password"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.PasswordAuthLink`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.generateOauthLink(oauth_provider, { ...params }) -> Vital.Source
-
#### 📝 Description
-
-
This endpoint generates an OAuth link for oauth provider
#### 🔌 Usage
-
-
```typescript
await client.link.generateOauthLink("oura", {
vitalLinkToken: "x-vital-link-token"
});
```
#### ⚙️ Parameters
-
-
**oauth_provider:** `Vital.OAuthProviders`
-
**request:** `Vital.LinkGenerateOauthLinkRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.connectPasswordProvider(provider, { ...params }) -> Vital.ProviderLinkResponse
-
#### 📝 Description
-
-
This connects auth providers that are password based.
#### 🔌 Usage
-
-
```typescript
await client.link.connectPasswordProvider("whoop", {
vitalLinkToken: "x-vital-link-token",
username: "username",
password: "password"
});
```
#### ⚙️ Parameters
-
-
**provider:** `Vital.PasswordProviders`
-
**request:** `Vital.IndividualProviderData`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.completePasswordProviderMfa(provider, { ...params }) -> Vital.ProviderLinkResponse
-
#### 📝 Description
-
-
This connects auth providers that are password based.
#### 🔌 Usage
-
-
```typescript
await client.link.completePasswordProviderMfa("whoop", {
vitalLinkToken: "x-vital-link-token",
mfaCode: "mfa_code"
});
```
#### ⚙️ Parameters
-
-
**provider:** `Vital.PasswordProviders`
-
**request:** `Vital.CompletePasswordProviderMfaBody`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.connectEmailAuthProvider(provider, { ...params }) -> unknown
-
#### 📝 Description
-
-
This connects auth providers that are email based.
#### 🔌 Usage
-
-
```typescript
await client.link.connectEmailAuthProvider("freestyle_libre", {
vitalLinkToken: "x-vital-link-token",
email: "email"
});
```
#### ⚙️ Parameters
-
-
**provider:** `Vital.EmailProviders`
-
**request:** `Vital.EmailProviderAuthLink`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.getAllProviders({ ...params }) -> Vital.SourceLink[]
-
#### 📝 Description
-
-
GET List of all available providers given the generated link token.
#### 🔌 Usage
-
-
```typescript
await client.link.getAllProviders({
vitalLinkToken: "x-vital-link-token"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LinkGetAllProvidersRequest`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.connectManualProvider(provider, { ...params }) -> Record
-
#### 🔌 Usage
-
-
```typescript
await client.link.connectManualProvider("beurer_ble", {
userId: "user_id"
});
```
#### ⚙️ Parameters
-
-
**provider:** `Vital.ManualProviders`
-
**request:** `Vital.ManualConnectionData`
-
**requestOptions:** `LinkClient.RequestOptions`
client.link.connectDemoProvider({ ...params }) -> Vital.DemoConnectionStatus
-
#### 📝 Description
-
-
POST Connect the given Vital user to a demo provider.
#### 🔌 Usage
-
-
```typescript
await client.link.connectDemoProvider({
userId: "user_id",
provider: "apple_health_kit"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.DemoConnectionCreationPayload`
-
**requestOptions:** `LinkClient.RequestOptions`
client.electrocardiogram.get(user_id, { ...params }) -> Vital.ClientFacingElectrocardiogramResponse
-
#### 📝 Description
-
-
Get electrocardiogram summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.electrocardiogram.get("user_id", {
startDate: "start_date",
endDate: "end_date",
provider: "provider"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.ElectrocardiogramGetRequest`
-
**requestOptions:** `ElectrocardiogramClient.RequestOptions`
client.sleepCycle.get(user_id, { ...params }) -> Vital.ClientSleepCycleResponse
-
#### 📝 Description
-
-
Get sleep cycle for user_id
#### 🔌 Usage
-
-
```typescript
await client.sleepCycle.get("user_id", {
startDate: "start_date",
endDate: "end_date",
provider: "provider"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.SleepCycleGetRequest`
-
**requestOptions:** `SleepCycleClient.RequestOptions`
client.profile.get(user_id, { ...params }) -> Vital.ClientFacingProfile
-
#### 📝 Description
-
-
Get profile for user_id
#### 🔌 Usage
-
-
```typescript
await client.profile.get("user_id", {
provider: "provider"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.ProfileGetRequest`
-
**requestOptions:** `ProfileClient.RequestOptions`
client.profile.getRaw(user_id, { ...params }) -> Vital.RawProfile
-
#### 📝 Description
-
-
Get raw profile for user_id
#### 🔌 Usage
-
-
```typescript
await client.profile.getRaw("user_id", {
provider: "provider"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.ProfileGetRawRequest`
-
**requestOptions:** `ProfileClient.RequestOptions`
client.devices.getRaw(user_id, { ...params }) -> Vital.RawDevices
-
#### 📝 Description
-
-
Get Devices for user_id
#### 🔌 Usage
-
-
```typescript
await client.devices.getRaw("user_id", {
provider: "provider"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.DevicesGetRawRequest`
-
**requestOptions:** `DevicesClient.RequestOptions`
client.activity.get(user_id, { ...params }) -> Vital.ClientActivityResponse
-
#### 📝 Description
-
-
Get activity summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.activity.get("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.ActivityGetRequest`
-
**requestOptions:** `ActivityClient.RequestOptions`
client.activity.getRaw(user_id, { ...params }) -> Vital.RawActivity
-
#### 📝 Description
-
-
Get raw activity summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.activity.getRaw("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.ActivityGetRawRequest`
-
**requestOptions:** `ActivityClient.RequestOptions`
client.workouts.get(user_id, { ...params }) -> Vital.ClientWorkoutResponse
-
#### 📝 Description
-
-
Get workout summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.workouts.get("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.WorkoutsGetRequest`
-
**requestOptions:** `WorkoutsClient.RequestOptions`
client.workouts.getRaw(user_id, { ...params }) -> Vital.RawWorkout
-
#### 📝 Description
-
-
Get raw workout summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.workouts.getRaw("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.WorkoutsGetRawRequest`
-
**requestOptions:** `WorkoutsClient.RequestOptions`
client.workouts.getByWorkoutId(workout_id) -> Vital.ClientFacingStream
-
#### 🔌 Usage
-
-
```typescript
await client.workouts.getByWorkoutId("workout_id");
```
#### ⚙️ Parameters
-
-
**workout_id:** `string` — The Vital ID for the workout
-
**requestOptions:** `WorkoutsClient.RequestOptions`
client.sleep.get(user_id, { ...params }) -> Vital.ClientSleepResponse
-
#### 📝 Description
-
-
Get sleep summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.sleep.get("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.SleepGetRequest`
-
**requestOptions:** `SleepClient.RequestOptions`
client.sleep.getRaw(user_id, { ...params }) -> Vital.RawSleep
-
#### 📝 Description
-
-
Get raw sleep summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.sleep.getRaw("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.SleepGetRawRequest`
-
**requestOptions:** `SleepClient.RequestOptions`
client.sleep.getStreamBySleepId(sleep_id) -> Vital.ClientFacingSleepStream
-
#### 📝 Description
-
-
Get Sleep stream for a user_id
#### 🔌 Usage
-
-
```typescript
await client.sleep.getStreamBySleepId("sleep_id");
```
#### ⚙️ Parameters
-
-
**sleep_id:** `string` — The Vital Sleep ID
-
**requestOptions:** `SleepClient.RequestOptions`
client.body.get(user_id, { ...params }) -> Vital.ClientBodyResponse
-
#### 📝 Description
-
-
Get Body summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.body.get("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.BodyGetRequest`
-
**requestOptions:** `BodyClient.RequestOptions`
client.body.getRaw(user_id, { ...params }) -> Vital.RawBody
-
#### 📝 Description
-
-
Get raw Body summary for user_id
#### 🔌 Usage
-
-
```typescript
await client.body.getRaw("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.BodyGetRawRequest`
-
**requestOptions:** `BodyClient.RequestOptions`
client.meal.get(user_id, { ...params }) -> Vital.ClientFacingMealResponse
-
#### 📝 Description
-
-
Get user's meals
#### 🔌 Usage
-
-
```typescript
await client.meal.get("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.MealGetRequest`
-
**requestOptions:** `MealClient.RequestOptions`
client.menstrualCycle.get(user_id, { ...params }) -> Vital.MenstrualCycleResponse
-
#### 🔌 Usage
-
-
```typescript
await client.menstrualCycle.get("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.MenstrualCycleGetRequest`
-
**requestOptions:** `MenstrualCycleClient.RequestOptions`
client.vitals.workoutSwimmingStrokeGrouped(user_id, { ...params }) -> Vital.GroupedWorkoutSwimmingStrokeResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.workoutSwimmingStrokeGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWorkoutSwimmingStrokeGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.workoutDistanceGrouped(user_id, { ...params }) -> Vital.GroupedWorkoutDistanceResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.workoutDistanceGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWorkoutDistanceGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.heartRateRecoveryOneMinuteGrouped(user_id, { ...params }) -> Vital.GroupedHeartRateRecoveryOneMinuteResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.heartRateRecoveryOneMinuteGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHeartRateRecoveryOneMinuteGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.waistCircumferenceGrouped(user_id, { ...params }) -> Vital.GroupedWaistCircumferenceResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.waistCircumferenceGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWaistCircumferenceGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.leanBodyMassGrouped(user_id, { ...params }) -> Vital.GroupedLeanBodyMassResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.leanBodyMassGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsLeanBodyMassGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyMassIndexGrouped(user_id, { ...params }) -> Vital.GroupedBodyMassIndexResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyMassIndexGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyMassIndexGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.basalBodyTemperatureGrouped(user_id, { ...params }) -> Vital.GroupedBasalBodyTemperatureResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.basalBodyTemperatureGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBasalBodyTemperatureGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.handwashingGrouped(user_id, { ...params }) -> Vital.GroupedHandwashingResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.handwashingGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHandwashingGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.daylightExposureGrouped(user_id, { ...params }) -> Vital.GroupedDaylightExposureResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.daylightExposureGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsDaylightExposureGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.uvExposureGrouped(user_id, { ...params }) -> Vital.GroupedUvExposureResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.uvExposureGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsUvExposureGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.fallGrouped(user_id, { ...params }) -> Vital.GroupedFallResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.fallGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsFallGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.inhalerUsageGrouped(user_id, { ...params }) -> Vital.GroupedInhalerUsageResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.inhalerUsageGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsInhalerUsageGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.peakExpiratoryFlowRateGrouped(user_id, { ...params }) -> Vital.GroupedPeakExpiratoryFlowRateResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.peakExpiratoryFlowRateGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsPeakExpiratoryFlowRateGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.forcedVitalCapacityGrouped(user_id, { ...params }) -> Vital.GroupedForcedVitalCapacityResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.forcedVitalCapacityGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsForcedVitalCapacityGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.forcedExpiratoryVolume1Grouped(user_id, { ...params }) -> Vital.GroupedForcedExpiratoryVolume1Response
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.forcedExpiratoryVolume1Grouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsForcedExpiratoryVolume1GroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.wheelchairPushGrouped(user_id, { ...params }) -> Vital.GroupedWheelchairPushResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.wheelchairPushGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWheelchairPushGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.sleepBreathingDisturbanceGrouped(user_id, { ...params }) -> Vital.GroupedSleepBreathingDisturbanceResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.sleepBreathingDisturbanceGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsSleepBreathingDisturbanceGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.sleepApneaAlertGrouped(user_id, { ...params }) -> Vital.GroupedSleepApneaAlertResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.sleepApneaAlertGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsSleepApneaAlertGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.standDurationGrouped(user_id, { ...params }) -> Vital.GroupedStandDurationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.standDurationGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsStandDurationGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.standHourGrouped(user_id, { ...params }) -> Vital.GroupedStandHourResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.standHourGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsStandHourGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.heartRateAlertGrouped(user_id, { ...params }) -> Vital.GroupedHeartRateAlertResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.heartRateAlertGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHeartRateAlertGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.afibBurdenGrouped(user_id, { ...params }) -> Vital.GroupedAFibBurdenResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.afibBurdenGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsAfibBurdenGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.workoutDurationGrouped(user_id, { ...params }) -> Vital.GroupedWorkoutDurationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.workoutDurationGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWorkoutDurationGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.vo2MaxGrouped(user_id, { ...params }) -> Vital.GroupedVo2MaxResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.vo2MaxGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsVo2MaxGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.stressLevelGrouped(user_id, { ...params }) -> Vital.GroupedStressLevelResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.stressLevelGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsStressLevelGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.mindfulnessMinutesGrouped(user_id, { ...params }) -> Vital.GroupedMindfulnessMinutesResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.mindfulnessMinutesGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsMindfulnessMinutesGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.caffeineGrouped(user_id, { ...params }) -> Vital.GroupedCaffeineResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.caffeineGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCaffeineGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.waterGrouped(user_id, { ...params }) -> Vital.GroupedWaterResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.waterGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWaterGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.stepsGrouped(user_id, { ...params }) -> Vital.GroupedStepsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.stepsGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsStepsGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.floorsClimbedGrouped(user_id, { ...params }) -> Vital.GroupedFloorsClimbedResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.floorsClimbedGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsFloorsClimbedGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.distanceGrouped(user_id, { ...params }) -> Vital.GroupedDistanceResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.distanceGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsDistanceGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.caloriesBasalGrouped(user_id, { ...params }) -> Vital.GroupedCaloriesBasalResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.caloriesBasalGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCaloriesBasalGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.caloriesActiveGrouped(user_id, { ...params }) -> Vital.GroupedCaloriesActiveResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.caloriesActiveGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCaloriesActiveGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.respiratoryRateGrouped(user_id, { ...params }) -> Vital.GroupedRespiratoryRateResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.respiratoryRateGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsRespiratoryRateGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.noteGrouped(user_id, { ...params }) -> Vital.GroupedNoteResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.noteGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsNoteGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.insulinInjectionGrouped(user_id, { ...params }) -> Vital.GroupedInsulinInjectionResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.insulinInjectionGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsInsulinInjectionGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.igeGrouped(user_id, { ...params }) -> Vital.GroupedIgeResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.igeGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsIgeGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.iggGrouped(user_id, { ...params }) -> Vital.GroupedIggResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.iggGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsIggGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.hypnogramGrouped(user_id, { ...params }) -> Vital.GroupedHypnogramResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.hypnogramGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHypnogramGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.hrvGrouped(user_id, { ...params }) -> Vital.GroupedHrvResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.hrvGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHrvGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.heartrateGrouped(user_id, { ...params }) -> Vital.GroupedHeartRateResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.heartrateGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHeartrateGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.glucoseGrouped(user_id, { ...params }) -> Vital.GroupedGlucoseResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.glucoseGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsGlucoseGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.cholesterolGrouped(user_id, { ...params }) -> Vital.GroupedCholesterolResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.cholesterolGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCholesterolGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.carbohydratesGrouped(user_id, { ...params }) -> Vital.GroupedCarbohydratesResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.carbohydratesGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCarbohydratesGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyTemperatureDeltaGrouped(user_id, { ...params }) -> Vital.GroupedBodyTemperatureDeltaResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyTemperatureDeltaGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyTemperatureDeltaGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyTemperatureGrouped(user_id, { ...params }) -> Vital.GroupedBodyTemperatureResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyTemperatureGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyTemperatureGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyWeightGrouped(user_id, { ...params }) -> Vital.GroupedBodyWeightResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyWeightGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyWeightGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyFatGrouped(user_id, { ...params }) -> Vital.GroupedBodyFatResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyFatGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyFatGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bloodOxygenGrouped(user_id, { ...params }) -> Vital.GroupedBloodOxygenResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bloodOxygenGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBloodOxygenGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.electrocardiogramVoltageGrouped(user_id, { ...params }) -> Vital.GroupedElectrocardiogramVoltageResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.electrocardiogramVoltageGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsElectrocardiogramVoltageGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bloodPressureGrouped(user_id, { ...params }) -> Vital.GroupedBloodPressureResponse
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bloodPressureGrouped("user_id", {
cursor: "cursor",
nextCursor: "next_cursor",
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBloodPressureGroupedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.vo2Max(user_id, { ...params }) -> Vital.ClientFacingVo2MaxTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.vo2Max("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsVo2MaxRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.stressLevel(user_id, { ...params }) -> Vital.ClientFacingStressLevelTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.stressLevel("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsStressLevelRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.mindfulnessMinutes(user_id, { ...params }) -> Vital.ClientFacingMindfulnessMinutesTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.mindfulnessMinutes("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsMindfulnessMinutesRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.caffeine(user_id, { ...params }) -> Vital.ClientFacingCaffeineTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.caffeine("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCaffeineRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.water(user_id, { ...params }) -> Vital.ClientFacingWaterTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.water("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsWaterRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.steps(user_id, { ...params }) -> Vital.ClientFacingStepsTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.steps("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsStepsRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.floorsClimbed(user_id, { ...params }) -> Vital.ClientFacingFloorsClimbedTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.floorsClimbed("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsFloorsClimbedRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.distance(user_id, { ...params }) -> Vital.ClientFacingDistanceTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.distance("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsDistanceRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.caloriesBasal(user_id, { ...params }) -> Vital.ClientFacingCaloriesBasalTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.caloriesBasal("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCaloriesBasalRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.caloriesActive(user_id, { ...params }) -> Vital.ClientFacingCaloriesActiveTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.caloriesActive("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCaloriesActiveRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.respiratoryRate(user_id, { ...params }) -> Vital.ClientFacingRespiratoryRateTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.respiratoryRate("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsRespiratoryRateRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.ige(user_id, { ...params }) -> Vital.ClientFacingIgeTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.ige("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsIgeRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.igg(user_id, { ...params }) -> Vital.ClientFacingIggTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.igg("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsIggRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.hypnogram(user_id, { ...params }) -> Vital.ClientFacingHypnogramTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.hypnogram("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHypnogramRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.hrv(user_id, { ...params }) -> Vital.ClientFacingHrvTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.hrv("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHrvRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.heartrate(user_id, { ...params }) -> Vital.ClientFacingHeartRateTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.heartrate("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsHeartrateRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.glucose(user_id, { ...params }) -> Vital.ClientFacingGlucoseTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.glucose("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsGlucoseRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.cholesterolTriglycerides(user_id, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.cholesterolTriglycerides("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCholesterolTriglyceridesRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.cholesterolTotal(user_id, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.cholesterolTotal("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCholesterolTotalRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.cholesterolLdl(user_id, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.cholesterolLdl("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCholesterolLdlRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.cholesterolHdl(user_id, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.cholesterolHdl("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCholesterolHdlRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.cholesterol(user_id, { ...params }) -> Vital.ClientFacingCholesterolTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.cholesterol("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsCholesterolRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyWeight(user_id, { ...params }) -> Vital.ClientFacingBodyWeightTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyWeight("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyWeightRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bodyFat(user_id, { ...params }) -> Vital.ClientFacingBodyFatTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bodyFat("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBodyFatRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bloodOxygen(user_id, { ...params }) -> Vital.ClientFacingBloodOxygenTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bloodOxygen("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBloodOxygenRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.electrocardiogramVoltage(user_id, { ...params }) -> Vital.ClientFacingElectrocardiogramVoltageTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.electrocardiogramVoltage("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsElectrocardiogramVoltageRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.vitals.bloodPressure(user_id, { ...params }) -> Vital.ClientFacingBloodPressureTimeseries[]
-
#### 🔌 Usage
-
-
```typescript
await client.vitals.bloodPressure("user_id", {
provider: "provider",
startDate: "start_date",
endDate: "end_date"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.VitalsBloodPressureRequest`
-
**requestOptions:** `VitalsClient.RequestOptions`
client.user.getAll({ ...params }) -> Vital.PaginatedUsersResponse
-
#### 📝 Description
-
-
GET All users for team.
#### 🔌 Usage
-
-
```typescript
await client.user.getAll({
offset: 1,
limit: 1
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.UserGetAllRequest`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.create({ ...params }) -> Vital.ClientFacingUserKey
-
#### 📝 Description
-
-
POST Create a Vital user given a client_user_id and returns the user_id.
#### 🔌 Usage
-
-
```typescript
await client.user.create({
clientUserId: "client_user_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.UserCreateBody`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getTeamMetrics() -> Vital.MetricsResult
-
#### 📝 Description
-
-
GET metrics for team.
#### 🔌 Usage
-
-
```typescript
await client.user.getTeamMetrics();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getConnectedProviders(user_id) -> Record
-
#### 📝 Description
-
-
GET Users connected providers
#### 🔌 Usage
-
-
```typescript
await client.user.getConnectedProviders("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getLatestUserInfo(user_id) -> Vital.UserInfo
-
#### 🔌 Usage
-
-
```typescript
await client.user.getLatestUserInfo("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.createInsurance(user_id, { ...params }) -> Vital.ClientFacingInsurance
-
#### 🔌 Usage
-
-
```typescript
await client.user.createInsurance("user_id", {
payorCode: "payor_code",
memberId: "member_id",
relationship: "Self",
insured: {
firstName: "first_name",
lastName: "last_name",
gender: "female",
address: {
firstLine: "first_line",
country: "country",
zip: "zip",
city: "city",
state: "state"
},
dob: "dob",
email: "email",
phoneNumber: "phone_number"
}
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.CreateInsuranceRequest`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getLatestInsurance(user_id, { ...params }) -> Vital.ClientFacingInsurance
-
#### 🔌 Usage
-
-
```typescript
await client.user.getLatestInsurance("user_id", {
isPrimary: true
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.UserGetLatestInsuranceRequest`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.upsertUserInfo(user_id, { ...params }) -> Vital.UserInfo
-
#### 🔌 Usage
-
-
```typescript
await client.user.upsertUserInfo("user_id", {
firstName: "first_name",
lastName: "last_name",
email: "email",
phoneNumber: "phone_number",
gender: "gender",
dob: "dob",
address: {
firstLine: "first_line",
country: "country",
zip: "zip",
city: "city",
state: "state"
}
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.UserInfoCreateRequest`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getByClientUserId(client_user_id) -> Vital.ClientFacingUser
-
#### 📝 Description
-
-
GET user_id from client_user_id.
#### 🔌 Usage
-
-
```typescript
await client.user.getByClientUserId("client_user_id");
```
#### ⚙️ Parameters
-
-
**client_user_id:** `string` — A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
-
**requestOptions:** `UserClient.RequestOptions`
client.user.deregisterProvider(user_id, provider) -> Vital.UserSuccessResponse
-
#### 🔌 Usage
-
-
```typescript
await client.user.deregisterProvider("user_id", "oura");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
-
**requestOptions:** `UserClient.RequestOptions`
client.user.get(user_id) -> Vital.ClientFacingUser
-
#### 🔌 Usage
-
-
```typescript
await client.user.get("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.delete(user_id) -> Vital.UserSuccessResponse
-
#### 🔌 Usage
-
-
```typescript
await client.user.delete("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.patch(user_id, { ...params }) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.user.patch("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.UserPatchBody`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.undoDelete({ ...params }) -> Vital.UserSuccessResponse
-
#### 🔌 Usage
-
-
```typescript
await client.user.undoDelete({
userId: "user_id",
clientUserId: "client_user_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.UserUndoDeleteRequest`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.refresh(user_id, { ...params }) -> Vital.UserRefreshSuccessResponse
-
#### 📝 Description
-
-
Trigger a manual refresh for a specific user
#### 🔌 Usage
-
-
```typescript
await client.user.refresh("user_id", {
timeout: 1.1
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.UserRefreshRequest`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getDevices(user_id) -> Vital.ClientFacingDevice[]
-
#### 🔌 Usage
-
-
```typescript
await client.user.getDevices("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getDevice(user_id, device_id) -> Vital.ClientFacingDevice
-
#### 🔌 Usage
-
-
```typescript
await client.user.getDevice("user_id", "device_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**device_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.getUserSignInToken(user_id) -> Vital.UserSignInTokenResponse
-
#### 🔌 Usage
-
-
```typescript
await client.user.getUserSignInToken("user_id");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**requestOptions:** `UserClient.RequestOptions`
client.user.createPortalUrl(user_id, { ...params }) -> Vital.CreateUserPortalUrlResponse
-
#### 🔌 Usage
-
-
```typescript
await client.user.createPortalUrl("user_id", {
context: "launch"
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.CreateUserPortalUrlBody`
-
**requestOptions:** `UserClient.RequestOptions`
client.team.getLinkConfig({ ...params }) -> Record
-
#### 📝 Description
-
-
Post teams.
#### 🔌 Usage
-
-
```typescript
await client.team.getLinkConfig({
vitalLinkToken: "x-vital-link-token"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.TeamGetLinkConfigRequest`
-
**requestOptions:** `TeamClient.RequestOptions`
client.team.get(team_id) -> Vital.ClientFacingTeam
-
#### 📝 Description
-
-
Get team.
#### 🔌 Usage
-
-
```typescript
await client.team.get("team_id");
```
#### ⚙️ Parameters
-
-
**team_id:** `string`
-
**requestOptions:** `TeamClient.RequestOptions`
client.team.getUserById({ ...params }) -> Vital.ClientFacingUser[]
-
#### 📝 Description
-
-
Search team users by user_id
#### 🔌 Usage
-
-
```typescript
await client.team.getUserById({
queryId: "query_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.TeamGetUserByIdRequest`
-
**requestOptions:** `TeamClient.RequestOptions`
client.team.getSvixUrl() -> Record
-
#### 🔌 Usage
-
-
```typescript
await client.team.getSvixUrl();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `TeamClient.RequestOptions`
client.team.getSourcePriorities({ ...params }) -> Record[]
-
#### 📝 Description
-
-
GET source priorities.
#### 🔌 Usage
-
-
```typescript
await client.team.getSourcePriorities({
dataType: "workouts"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.TeamGetSourcePrioritiesRequest`
-
**requestOptions:** `TeamClient.RequestOptions`
client.team.updateSourcePriorities() -> Record[]
-
#### 📝 Description
-
-
Patch source priorities.
#### 🔌 Usage
-
-
```typescript
await client.team.updateSourcePriorities();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `TeamClient.RequestOptions`
client.team.getPhysicians(team_id) -> Vital.ClientFacingPhysician[]
-
#### 🔌 Usage
-
-
```typescript
await client.team.getPhysicians("team_id");
```
#### ⚙️ Parameters
-
-
**team_id:** `string`
-
**requestOptions:** `TeamClient.RequestOptions`
client.providers.getAll({ ...params }) -> Vital.ClientFacingProviderDetailed[]
-
#### 📝 Description
-
-
Get Provider list
#### 🔌 Usage
-
-
```typescript
await client.providers.getAll({
sourceType: "source_type"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.ProvidersGetAllRequest`
-
**requestOptions:** `ProvidersClient.RequestOptions`
client.introspect.getUserResources({ ...params }) -> Vital.UserResourcesResponse
-
#### 🔌 Usage
-
-
```typescript
await client.introspect.getUserResources({
userId: "user_id",
provider: "oura",
userLimit: 1,
cursor: "cursor",
nextCursor: "next_cursor"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.IntrospectGetUserResourcesRequest`
-
**requestOptions:** `IntrospectClient.RequestOptions`
client.introspect.getUserHistoricalPulls({ ...params }) -> Vital.UserHistoricalPullsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.introspect.getUserHistoricalPulls({
userId: "user_id",
provider: "oura",
userLimit: 1,
cursor: "cursor",
nextCursor: "next_cursor"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.IntrospectGetUserHistoricalPullsRequest`
-
**requestOptions:** `IntrospectClient.RequestOptions`
client.labTests.get({ ...params }) -> Vital.ClientFacingLabTest[]
-
#### 📝 Description
-
-
GET all the lab tests the team has access to.
#### 🔌 Usage
-
-
```typescript
await client.labTests.get({
generationMethod: "auto",
labSlug: "lab_slug",
collectionMethod: "testkit",
status: "active",
name: "name",
orderKey: "price",
orderDirection: "asc"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.create({ ...params }) -> Vital.ClientFacingLabTest
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.create({
name: "name",
method: "testkit",
description: "description"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.CreateLabTestRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getById(lab_test_id, { ...params }) -> Vital.ClientFacingLabTest
-
#### 📝 Description
-
-
GET all the lab tests the team has access to.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getById("lab_test_id", {
labAccountId: "lab_account_id"
});
```
#### ⚙️ Parameters
-
-
**lab_test_id:** `string`
-
**request:** `Vital.LabTestsGetByIdRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.updateLabTest(lab_test_id, { ...params }) -> Vital.ClientFacingLabTest
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.updateLabTest("lab_test_id");
```
#### ⚙️ Parameters
-
-
**lab_test_id:** `string`
-
**request:** `Vital.UpdateLabTestRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getMarkers({ ...params }) -> Vital.GetMarkersResponse
-
#### 📝 Description
-
-
GET all the markers for the given lab.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getMarkers({
name: "name",
aLaCarteEnabled: true,
labAccountId: "lab_account_id",
page: 1,
size: 1
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetMarkersRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getMarkersForOrderSet({ ...params }) -> Vital.GetMarkersResponse
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getMarkersForOrderSet({
page: 1,
size: 1,
body: {}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetMarkersForOrderSetRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getMarkersForLabTest(lab_test_id, { ...params }) -> Vital.GetMarkersResponse
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getMarkersForLabTest("lab_test_id", {
labAccountId: "lab_account_id",
page: 1,
size: 1
});
```
#### ⚙️ Parameters
-
-
**lab_test_id:** `string`
-
**request:** `Vital.LabTestsGetMarkersForLabTestRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getMarkersByLabAndProviderId(provider_id, lab_id, { ...params }) -> Vital.ClientFacingMarker
-
#### 📝 Description
-
-
GET a specific marker for the given lab and provider_id
#### 🔌 Usage
-
-
```typescript
await client.labTests.getMarkersByLabAndProviderId("provider_id", 1, {
labAccountId: "lab_account_id"
});
```
#### ⚙️ Parameters
-
-
**provider_id:** `string`
-
**lab_id:** `number`
-
**request:** `Vital.LabTestsGetMarkersByLabAndProviderIdRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getLabs() -> Vital.ClientFacingLab[]
-
#### 📝 Description
-
-
GET all the labs.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getLabs();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPaginated({ ...params }) -> Vital.LabTestResourcesResponse
-
#### 📝 Description
-
-
GET lab tests the team has access to as a paginated list.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPaginated({
labTestLimit: 1,
nextCursor: "next_cursor",
generationMethod: "auto",
labSlug: "lab_slug",
collectionMethod: "testkit",
status: "active",
name: "name",
orderKey: "price",
orderDirection: "asc"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetPaginatedRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getLabTestCollectionInstructionPdf(lab_test_id) -> core.BinaryResponse
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getLabTestCollectionInstructionPdf("lab_test_id");
```
#### ⚙️ Parameters
-
-
**lab_test_id:** `string`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getOrders({ ...params }) -> Vital.GetOrdersResponse
-
#### 📝 Description
-
-
GET many orders with filters.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getOrders({
searchInput: "search_input",
startDate: new Date("2024-01-15T09:30:00.000Z"),
endDate: new Date("2024-01-15T09:30:00.000Z"),
updatedStartDate: new Date("2024-01-15T09:30:00.000Z"),
updatedEndDate: new Date("2024-01-15T09:30:00.000Z"),
orderKey: "created_at",
orderDirection: "asc",
isCritical: true,
interpretation: "normal",
userId: "user_id",
patientName: "patient_name",
shippingRecipientName: "shipping_recipient_name",
page: 1,
size: 1
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetOrdersRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPhlebotomyAppointmentAvailability({ ...params }) -> Vital.AppointmentAvailabilitySlots
-
#### 📝 Description
-
-
Return the available time slots to book an appointment with a phlebotomist
for the given address and order.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPhlebotomyAppointmentAvailability({
startDate: "start_date",
body: {
firstLine: "first_line",
city: "city",
state: "state",
zipCode: "zip_code"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetPhlebotomyAppointmentAvailabilityRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.bookPhlebotomyAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 📝 Description
-
-
Book an at-home phlebotomy appointment.
#### 🔌 Usage
-
-
```typescript
await client.labTests.bookPhlebotomyAppointment("order_id", {
bookingKey: "booking_key"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.AppointmentBookingRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.requestPhlebotomyAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 📝 Description
-
-
Request an at-home phlebotomy appointment.
#### 🔌 Usage
-
-
```typescript
await client.labTests.requestPhlebotomyAppointment("order_id", {
address: {
firstLine: "first_line",
city: "city",
state: "state",
zipCode: "zip_code"
},
provider: "getlabs"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.RequestAppointmentRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.reschedulePhlebotomyAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 📝 Description
-
-
Reschedule a previously booked at-home phlebotomy appointment.
#### 🔌 Usage
-
-
```typescript
await client.labTests.reschedulePhlebotomyAppointment("order_id", {
bookingKey: "booking_key"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.AppointmentRescheduleRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.cancelPhlebotomyAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 📝 Description
-
-
Cancel a previously booked at-home phlebotomy appointment.
#### 🔌 Usage
-
-
```typescript
await client.labTests.cancelPhlebotomyAppointment("order_id", {
cancellationReasonId: "cancellation_reason_id"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.ApiApiV1EndpointsVitalApiLabTestingOrdersHelpersAppointmentCancelRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPhlebotomyAppointmentCancellationReason() -> Vital.ClientFacingAppointmentCancellationReason[]
-
#### 📝 Description
-
-
Get the list of reasons for cancelling an at-home phlebotomy appointment.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPhlebotomyAppointmentCancellationReason();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPhlebotomyAppointment(order_id) -> Vital.ClientFacingAppointment
-
#### 📝 Description
-
-
Get the appointment associated with an order.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPhlebotomyAppointment("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getAreaInfo({ ...params }) -> Vital.AreaInfo
-
#### 📝 Description
-
-
GET information about an area with respect to lab-testing.
Information returned:
* Whether a given zip code is served by our Phlebotomy network.
* List of Lab locations in the area.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getAreaInfo({
zipCode: "zip_code",
radius: "10",
lab: "quest",
labAccountId: "lab_account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetAreaInfoRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPscInfo({ ...params }) -> Vital.PscInfo
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPscInfo({
zipCode: "zip_code",
labId: 1,
radius: "10",
labAccountId: "lab_account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetPscInfoRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getOrderPscInfo(order_id, { ...params }) -> Vital.PscInfo
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getOrderPscInfo("order_id", {
radius: "10"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.LabTestsGetOrderPscInfoRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getResultPdf(order_id) -> core.BinaryResponse
-
#### 📝 Description
-
-
This endpoint returns the lab results for the order.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getResultPdf("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getResultMetadata(order_id) -> Vital.LabResultsMetadata
-
#### 📝 Description
-
-
Return metadata related to order results, such as lab metadata,
provider and sample dates.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getResultMetadata("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getResultRaw(order_id) -> Vital.LabResultsRaw
-
#### 📝 Description
-
-
Return both metadata and raw json test data
#### 🔌 Usage
-
-
```typescript
await client.labTests.getResultRaw("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getLabelsPdf(order_id, { ...params }) -> core.BinaryResponse
-
#### 📝 Description
-
-
This endpoint returns the printed labels for the order.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getLabelsPdf("order_id", {
collectionDate: new Date("2024-01-15T09:30:00.000Z")
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string`
-
**request:** `Vital.LabTestsGetLabelsPdfRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPscAppointmentAvailability({ ...params }) -> Vital.AppointmentAvailabilitySlots
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPscAppointmentAvailability({
lab: "quest",
startDate: "start_date",
zipCode: "zip_code",
radius: "10"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.LabTestsGetPscAppointmentAvailabilityRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.bookPscAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.bookPscAppointment("order_id", {
bookingKey: "booking_key"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.AppointmentBookingRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.reschedulePscAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.reschedulePscAppointment("order_id", {
bookingKey: "booking_key"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.AppointmentRescheduleRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.cancelPscAppointment(order_id, { ...params }) -> Vital.ClientFacingAppointment
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.cancelPscAppointment("order_id", {
cancellationReasonId: "cancellationReasonId"
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**request:** `Vital.VitalCoreClientsLabTestGetlabsSchemaAppointmentCancelRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPscAppointmentCancellationReason() -> Vital.ClientFacingAppointmentCancellationReason[]
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPscAppointmentCancellationReason();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getPscAppointment(order_id) -> Vital.ClientFacingAppointment
-
#### 📝 Description
-
-
Get the appointment associated with an order.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getPscAppointment("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getOrderCollectionInstructionPdf(order_id) -> core.BinaryResponse
-
#### 📝 Description
-
-
GET collection instructions for an order
#### 🔌 Usage
-
-
```typescript
await client.labTests.getOrderCollectionInstructionPdf("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getOrderRequistionPdf(order_id) -> core.BinaryResponse
-
#### 📝 Description
-
-
GET requisition pdf for an order
#### 🔌 Usage
-
-
```typescript
await client.labTests.getOrderRequistionPdf("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getOrderAbnPdf(order_id) -> core.BinaryResponse
-
#### 📝 Description
-
-
GET ABN pdf for an order
#### 🔌 Usage
-
-
```typescript
await client.labTests.getOrderAbnPdf("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.getOrder(order_id) -> Vital.ClientFacingOrder
-
#### 📝 Description
-
-
GET individual order by ID.
#### 🔌 Usage
-
-
```typescript
await client.labTests.getOrder("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.createOrder({ ...params }) -> Vital.PostOrderResponse
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.createOrder({
idempotencyKey: "X-Idempotency-Key",
idempotencyError: "no-cache",
userId: "user_id",
patientDetails: {
firstName: "first_name",
lastName: "last_name",
dob: "dob",
gender: "female",
phoneNumber: "phone_number",
email: "email"
},
patientAddress: {
firstLine: "first_line",
city: "city",
state: "state",
zip: "zip",
country: "country"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.CreateOrderRequestCompatible`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.importOrder({ ...params }) -> Vital.PostOrderResponse
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.importOrder({
userId: "user_id",
billingType: "client_bill",
orderSet: {},
collectionMethod: "testkit",
patientDetails: {
firstName: "first_name",
lastName: "last_name",
dob: "dob",
gender: "female",
phoneNumber: "phone_number",
email: "email"
},
patientAddress: {
receiverName: "receiver_name",
firstLine: "first_line",
city: "city",
state: "state",
zip: "zip",
country: "country"
},
sampleId: "sample_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.ImportOrderBody`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.cancelOrder(order_id) -> Vital.PostOrderResponse
-
#### 📝 Description
-
-
POST cancel order
#### 🔌 Usage
-
-
```typescript
await client.labTests.cancelOrder("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.simulateOrderProcess(order_id, { ...params }) -> unknown
-
#### 📝 Description
-
-
Get available test kits.
#### 🔌 Usage
-
-
```typescript
await client.labTests.simulateOrderProcess("order_id", {
finalStatus: "received.walk_in_test.ordered",
delay: 1,
body: {}
});
```
#### ⚙️ Parameters
-
-
**order_id:** `string`
-
**request:** `Vital.LabTestsSimulateOrderProcessRequest`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.updateOnSiteCollectionOrderDrawCompleted(order_id) -> Vital.PostOrderResponse
-
#### 📝 Description
-
-
PATCH update on site collection order when draw is completed
#### 🔌 Usage
-
-
```typescript
await client.labTests.updateOnSiteCollectionOrderDrawCompleted("order_id");
```
#### ⚙️ Parameters
-
-
**order_id:** `string` — Your Order ID.
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.labTests.validateIcdCodes({ ...params }) -> Vital.ValidateIcdCodesResponse
-
#### 🔌 Usage
-
-
```typescript
await client.labTests.validateIcdCodes({
codes: ["codes"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.ValidateIcdCodesBody`
-
**requestOptions:** `LabTestsClient.RequestOptions`
client.testkit.register({ ...params }) -> Vital.PostOrderResponse
-
#### 🔌 Usage
-
-
```typescript
await client.testkit.register({
sampleId: "sample_id",
patientDetails: {
firstName: "first_name",
lastName: "last_name",
dob: "dob",
gender: "female",
phoneNumber: "phone_number",
email: "email"
},
patientAddress: {
firstLine: "first_line",
city: "city",
state: "state",
zip: "zip",
country: "country"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.RegisterTestkitRequest`
-
**requestOptions:** `TestkitClient.RequestOptions`
client.testkit.createOrder({ ...params }) -> Vital.PostOrderResponse
-
#### 📝 Description
-
-
Creates an order for an unregistered testkit
#### 🔌 Usage
-
-
```typescript
await client.testkit.createOrder({
userId: "user_id",
labTestId: "lab_test_id",
shippingDetails: {
receiverName: "receiver_name",
firstLine: "first_line",
city: "city",
state: "state",
zip: "zip",
country: "country",
phoneNumber: "phone_number"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.CreateRegistrableTestkitOrderRequest`
-
**requestOptions:** `TestkitClient.RequestOptions`
client.order.resendEvents({ ...params }) -> Vital.ResendWebhookResponse
-
#### 📝 Description
-
-
Replay a webhook for a given set of orders
#### 🔌 Usage
-
-
```typescript
await client.order.resendEvents();
```
#### ⚙️ Parameters
-
-
**request:** `Vital.ResendWebhookBody`
-
**requestOptions:** `OrderClient.RequestOptions`
client.insurance.searchGetPayorInfo({ ...params }) -> Vital.ClientFacingPayorSearchResponse[]
-
#### 🔌 Usage
-
-
```typescript
await client.insurance.searchGetPayorInfo({
insuranceName: "insurance_name",
provider: "change_healthcare",
providerPayorId: "provider_payor_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.InsuranceSearchGetPayorInfoRequest`
-
**requestOptions:** `InsuranceClient.RequestOptions`
client.insurance.searchPayorInfo({ ...params }) -> Vital.ClientFacingPayorSearchResponseDeprecated[]
-
#### 🔌 Usage
-
-
```typescript
await client.insurance.searchPayorInfo();
```
#### ⚙️ Parameters
-
-
**request:** `Vital.PayorSearchRequest`
-
**requestOptions:** `InsuranceClient.RequestOptions`
client.insurance.searchDiagnosis({ ...params }) -> Vital.ClientFacingDiagnosisInformation[]
-
#### 🔌 Usage
-
-
```typescript
await client.insurance.searchDiagnosis({
diagnosisQuery: "diagnosis_query"
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.InsuranceSearchDiagnosisRequest`
-
**requestOptions:** `InsuranceClient.RequestOptions`
client.payor.createPayor({ ...params }) -> Vital.ClientFacingPayor
-
#### 🔌 Usage
-
-
```typescript
await client.payor.createPayor({
name: "name",
address: {
firstLine: "first_line",
country: "country",
zip: "zip",
city: "city",
state: "state"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Vital.CreatePayorBody`
-
**requestOptions:** `PayorClient.RequestOptions`
client.labReport.parserCreateJob(file, { ...params }) -> Vital.ParsingJob
-
#### 📝 Description
-
-
Creates a parse job, uploads the file to provider, persists the job row,
and starts the ParseLabReport. Returns a generated job_id.
#### 🔌 Usage
-
-
```typescript
await client.labReport.parserCreateJob(createReadStream("path/to/file"), {
userId: "user_id"
});
```
#### ⚙️ Parameters
-
-
**file:** `core.file.Uploadable`
-
**request:** `Vital.BodyCreateLabReportParserJob`
-
**requestOptions:** `LabReportClient.RequestOptions`
client.labReport.parserGetJob(job_id) -> Vital.ParsingJob
-
#### 📝 Description
-
-
Retrieves the parse job status and stored result if completed.
Returns:
ParseLabResultJobResponse with job status and parsed data (if complete)
#### 🔌 Usage
-
-
```typescript
await client.labReport.parserGetJob("job_id");
```
#### ⚙️ Parameters
-
-
**job_id:** `string`
-
**requestOptions:** `LabReportClient.RequestOptions`
client.aggregate.queryOne(user_id, { ...params }) -> Vital.AggregationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.aggregate.queryOne("user_id", {
timeframe: {
type: "relative",
anchor: "anchor",
past: {
unit: "minute"
}
},
queries: [{
select: [{
arg: {
sleep: "id"
},
func: "mean"
}]
}]
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**request:** `Vital.QueryBatch`
-
**requestOptions:** `AggregateClient.RequestOptions`
client.aggregate.getResultTableForContinuousQuery(user_id, query_id_or_slug) -> Vital.AggregationResult
-
#### 🔌 Usage
-
-
```typescript
await client.aggregate.getResultTableForContinuousQuery("user_id", "query_id_or_slug");
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**query_id_or_slug:** `string`
-
**requestOptions:** `AggregateClient.RequestOptions`
client.aggregate.getTaskHistoryForContinuousQuery(user_id, query_id_or_slug, { ...params }) -> Vital.ContinuousQueryTaskHistoryResponse
-
#### 🔌 Usage
-
-
```typescript
await client.aggregate.getTaskHistoryForContinuousQuery("user_id", "query_id_or_slug", {
nextCursor: "next_cursor",
limit: 1
});
```
#### ⚙️ Parameters
-
-
**user_id:** `string`
-
**query_id_or_slug:** `string`
-
**request:** `Vital.AggregateGetTaskHistoryForContinuousQueryRequest`
-
**requestOptions:** `AggregateClient.RequestOptions`