@tryvital/vital-node 3.0.9 → 3.1.1

package/dist/api/resources/vitals/client/Client.d.ts

@@ -18,7 +18,231 @@ export declare class Vitals {
     protected readonly _options: Vitals.Options;
     constructor(_options: Vitals.Options);
     /**
-     * Get timeseries data for user
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.vo2MaxGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    vo2MaxGrouped(userId: string, request: Vital.VitalsVo2MaxGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedVo2MaxResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.stressLevelGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    stressLevelGrouped(userId: string, request: Vital.VitalsStressLevelGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedStressLevelResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.mindfulnessMinutesGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    mindfulnessMinutesGrouped(userId: string, request: Vital.VitalsMindfulnessMinutesGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedMindfulnessMinutesResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.caffeineGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    caffeineGrouped(userId: string, request: Vital.VitalsCaffeineGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCaffeineResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.waterGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    waterGrouped(userId: string, request: Vital.VitalsWaterGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedWaterResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.stepsGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    stepsGrouped(userId: string, request: Vital.VitalsStepsGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedStepsResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.floorsClimbedGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    floorsClimbedGrouped(userId: string, request: Vital.VitalsFloorsClimbedGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedFloorsClimbedResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.distanceGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    distanceGrouped(userId: string, request: Vital.VitalsDistanceGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedDistanceResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.caloriesBasalGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    caloriesBasalGrouped(userId: string, request: Vital.VitalsCaloriesBasalGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCaloriesBasalResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.caloriesActiveGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    caloriesActiveGrouped(userId: string, request: Vital.VitalsCaloriesActiveGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCaloriesActiveResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.respiratoryRateGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    respiratoryRateGrouped(userId: string, request: Vital.VitalsRespiratoryRateGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedRespiratoryRateResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.igeGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    igeGrouped(userId: string, request: Vital.VitalsIgeGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedIgeResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.iggGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    iggGrouped(userId: string, request: Vital.VitalsIggGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedIggResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.hypnogramGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    hypnogramGrouped(userId: string, request: Vital.VitalsHypnogramGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedHypnogramResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.hrvGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    hrvGrouped(userId: string, request: Vital.VitalsHrvGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedHrvResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.heartrateGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    heartrateGrouped(userId: string, request: Vital.VitalsHeartrateGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedHeartRateResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.glucoseGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    glucoseGrouped(userId: string, request: Vital.VitalsGlucoseGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedGlucoseResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.cholesterolGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    cholesterolGrouped(userId: string, request: Vital.VitalsCholesterolGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCholesterolResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bodyWeightGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    bodyWeightGrouped(userId: string, request: Vital.VitalsBodyWeightGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBodyWeightResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bodyFatGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    bodyFatGrouped(userId: string, request: Vital.VitalsBodyFatGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBodyFatResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bloodOxygenGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    bloodOxygenGrouped(userId: string, request: Vital.VitalsBloodOxygenGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBloodOxygenResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.electrocardiogramVoltageGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    electrocardiogramVoltageGrouped(userId: string, request: Vital.VitalsElectrocardiogramVoltageGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedElectrocardiogramVoltageResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bloodPressureGrouped("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    bloodPressureGrouped(userId: string, request: Vital.VitalsBloodPressureGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBloodPressureResponse>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.vo2Max("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    vo2Max(userId: string, request: Vital.VitalsVo2MaxRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingVo2MaxTimeseries[]>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.stressLevel("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    stressLevel(userId: string, request: Vital.VitalsStressLevelRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingStressLevelTimeseries[]>;
+    /**
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -28,7 +252,6 @@ export declare class Vitals {
      */
     mindfulnessMinutes(userId: string, request: Vital.VitalsMindfulnessMinutesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingMindfulnessMinutesTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -38,7 +261,6 @@ export declare class Vitals {
      */
     caffeine(userId: string, request: Vital.VitalsCaffeineRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaffeineTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -48,7 +270,6 @@ export declare class Vitals {
      */
     water(userId: string, request: Vital.VitalsWaterRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingWaterTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -58,7 +279,6 @@ export declare class Vitals {
      */
     steps(userId: string, request: Vital.VitalsStepsRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingStepsTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -68,7 +288,6 @@ export declare class Vitals {
      */
     floorsClimbed(userId: string, request: Vital.VitalsFloorsClimbedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingFloorsClimbedTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -78,7 +297,6 @@ export declare class Vitals {
      */
     distance(userId: string, request: Vital.VitalsDistanceRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingDistanceTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -88,7 +306,6 @@ export declare class Vitals {
      */
     caloriesBasal(userId: string, request: Vital.VitalsCaloriesBasalRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaloriesBasalTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -98,7 +315,6 @@ export declare class Vitals {
      */
     caloriesActive(userId: string, request: Vital.VitalsCaloriesActiveRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaloriesActiveTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -108,7 +324,6 @@ export declare class Vitals {
      */
     respiratoryRate(userId: string, request: Vital.VitalsRespiratoryRateRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingRespiratoryRateTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -118,7 +333,6 @@ export declare class Vitals {
      */
     ige(userId: string, request: Vital.VitalsIgeRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingIgeTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -128,7 +342,6 @@ export declare class Vitals {
      */
     igg(userId: string, request: Vital.VitalsIggRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingIggTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -138,7 +351,6 @@ export declare class Vitals {
      */
     hypnogram(userId: string, request: Vital.VitalsHypnogramRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHypnogramTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -148,7 +360,6 @@ export declare class Vitals {
      */
     hrv(userId: string, request: Vital.VitalsHrvRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHrvTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -158,7 +369,6 @@ export declare class Vitals {
      */
     heartrate(userId: string, request: Vital.VitalsHeartrateRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHeartRateTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -168,17 +378,15 @@ export declare class Vitals {
      */
     glucose(userId: string, request: Vital.VitalsGlucoseRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGlucoseTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.triglycerides("user-id", {
+     *     await vital.vitals.cholesterolTriglycerides("user-id", {
      *         startDate: "start-date"
      *     })
      */
-    triglycerides(userId: string, request: Vital.VitalsTriglyceridesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
+    cholesterolTriglycerides(userId: string, request: Vital.VitalsCholesterolTriglyceridesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -188,27 +396,24 @@ export declare class Vitals {
      */
     cholesterolTotal(userId: string, request: Vital.VitalsCholesterolTotalRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolHdl("user-id", {
+     *     await vital.vitals.cholesterolLdl("user-id", {
      *         startDate: "start-date"
      *     })
      */
-    cholesterolHdl(userId: string, request: Vital.VitalsCholesterolHdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
+    cholesterolLdl(userId: string, request: Vital.VitalsCholesterolLdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolLdl("user-id", {
+     *     await vital.vitals.cholesterolHdl("user-id", {
      *         startDate: "start-date"
      *     })
      */
-    cholesterolLdl(userId: string, request: Vital.VitalsCholesterolLdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
+    cholesterolHdl(userId: string, request: Vital.VitalsCholesterolHdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -218,7 +423,24 @@ export declare class Vitals {
      */
     cholesterol(userId: string, request: Vital.VitalsCholesterolRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
-     * Get timeseries data for user
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bodyWeight("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    bodyWeight(userId: string, request: Vital.VitalsBodyWeightRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBodyWeightTimeseries[]>;
+    /**
+     * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bodyFat("user-id", {
+     *         startDate: "start-date"
+     *     })
+     */
+    bodyFat(userId: string, request: Vital.VitalsBodyFatRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBodyFatTimeseries[]>;
+    /**
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -228,7 +450,6 @@ export declare class Vitals {
      */
     bloodOxygen(userId: string, request: Vital.VitalsBloodOxygenRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBloodOxygenTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
@@ -238,7 +459,6 @@ export declare class Vitals {
      */
     electrocardiogramVoltage(userId: string, request: Vital.VitalsElectrocardiogramVoltageRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingElectrocardiogramVoltageTimeseries[]>;
     /**
-     * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example