@tryvital/vital-node 3.1.69 → 3.1.71

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

@@ -3,525 +3,753 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vital from "../../..";
+import * as Vital from "../../../index";
 export declare namespace Vitals {
     interface Options {
         environment?: core.Supplier<environments.VitalEnvironment | string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class Vitals {
     protected readonly _options: Vitals.Options;
-    constructor(_options: Vitals.Options);
+    constructor(_options?: Vitals.Options);
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsWorkoutDurationGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.workoutDurationGrouped("user_id", {
+     *     await client.vitals.workoutDurationGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     workoutDurationGrouped(userId: string, request: Vital.VitalsWorkoutDurationGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGroupedTimeseriesResponseClientFacingWorkoutDurationSample>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsVo2MaxGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.vo2MaxGrouped("user_id", {
+     *     await client.vitals.vo2MaxGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     vo2MaxGrouped(userId: string, request: Vital.VitalsVo2MaxGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedVo2MaxResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsStressLevelGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.stressLevelGrouped("user_id", {
+     *     await client.vitals.stressLevelGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     stressLevelGrouped(userId: string, request: Vital.VitalsStressLevelGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedStressLevelResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsMindfulnessMinutesGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.mindfulnessMinutesGrouped("user_id", {
+     *     await client.vitals.mindfulnessMinutesGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     mindfulnessMinutesGrouped(userId: string, request: Vital.VitalsMindfulnessMinutesGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedMindfulnessMinutesResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCaffeineGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.caffeineGrouped("user_id", {
+     *     await client.vitals.caffeineGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     caffeineGrouped(userId: string, request: Vital.VitalsCaffeineGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCaffeineResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsWaterGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.waterGrouped("user_id", {
+     *     await client.vitals.waterGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     waterGrouped(userId: string, request: Vital.VitalsWaterGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedWaterResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsStepsGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.stepsGrouped("user_id", {
+     *     await client.vitals.stepsGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     stepsGrouped(userId: string, request: Vital.VitalsStepsGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedStepsResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsFloorsClimbedGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.floorsClimbedGrouped("user_id", {
+     *     await client.vitals.floorsClimbedGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     floorsClimbedGrouped(userId: string, request: Vital.VitalsFloorsClimbedGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedFloorsClimbedResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsDistanceGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.distanceGrouped("user_id", {
+     *     await client.vitals.distanceGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     distanceGrouped(userId: string, request: Vital.VitalsDistanceGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedDistanceResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCaloriesBasalGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.caloriesBasalGrouped("user_id", {
+     *     await client.vitals.caloriesBasalGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     caloriesBasalGrouped(userId: string, request: Vital.VitalsCaloriesBasalGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCaloriesBasalResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCaloriesActiveGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.caloriesActiveGrouped("user_id", {
+     *     await client.vitals.caloriesActiveGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     caloriesActiveGrouped(userId: string, request: Vital.VitalsCaloriesActiveGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCaloriesActiveResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsRespiratoryRateGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.respiratoryRateGrouped("user_id", {
+     *     await client.vitals.respiratoryRateGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     respiratoryRateGrouped(userId: string, request: Vital.VitalsRespiratoryRateGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedRespiratoryRateResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsNoteGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.noteGrouped("user_id", {
+     *     await client.vitals.noteGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     noteGrouped(userId: string, request: Vital.VitalsNoteGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGroupedTimeseriesResponseClientFacingNoteSample>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsInsulinInjectionGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.insulinInjectionGrouped("user_id", {
+     *     await client.vitals.insulinInjectionGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     insulinInjectionGrouped(userId: string, request: Vital.VitalsInsulinInjectionGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGroupedTimeseriesResponseClientFacingInsulinInjectionSample>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsIgeGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.igeGrouped("user_id", {
+     *     await client.vitals.igeGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     igeGrouped(userId: string, request: Vital.VitalsIgeGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedIgeResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsIggGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.iggGrouped("user_id", {
+     *     await client.vitals.iggGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     iggGrouped(userId: string, request: Vital.VitalsIggGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedIggResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsHypnogramGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.hypnogramGrouped("user_id", {
+     *     await client.vitals.hypnogramGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     hypnogramGrouped(userId: string, request: Vital.VitalsHypnogramGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedHypnogramResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsHrvGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.hrvGrouped("user_id", {
+     *     await client.vitals.hrvGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     hrvGrouped(userId: string, request: Vital.VitalsHrvGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedHrvResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsHeartrateGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.heartrateGrouped("user_id", {
+     *     await client.vitals.heartrateGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     heartrateGrouped(userId: string, request: Vital.VitalsHeartrateGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedHeartRateResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsGlucoseGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.glucoseGrouped("user_id", {
+     *     await client.vitals.glucoseGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     glucoseGrouped(userId: string, request: Vital.VitalsGlucoseGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedGlucoseResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCholesterolGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolGrouped("user_id", {
+     *     await client.vitals.cholesterolGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     cholesterolGrouped(userId: string, request: Vital.VitalsCholesterolGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedCholesterolResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCarbohydratesGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.carbohydratesGrouped("user_id", {
+     *     await client.vitals.carbohydratesGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     carbohydratesGrouped(userId: string, request: Vital.VitalsCarbohydratesGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGroupedTimeseriesResponseClientFacingCarbohydratesSample>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBodyTemperatureDeltaGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bodyTemperatureDeltaGrouped("user_id", {
+     *     await client.vitals.bodyTemperatureDeltaGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bodyTemperatureDeltaGrouped(userId: string, request: Vital.VitalsBodyTemperatureDeltaGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGroupedTimeseriesResponseClientFacingBodyTemperatureDeltaSample>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBodyTemperatureGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bodyTemperatureGrouped("user_id", {
+     *     await client.vitals.bodyTemperatureGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bodyTemperatureGrouped(userId: string, request: Vital.VitalsBodyTemperatureGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGroupedTimeseriesResponseClientFacingBodyTemperatureSample>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBodyWeightGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bodyWeightGrouped("user_id", {
+     *     await client.vitals.bodyWeightGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bodyWeightGrouped(userId: string, request: Vital.VitalsBodyWeightGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBodyWeightResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBodyFatGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bodyFatGrouped("user_id", {
+     *     await client.vitals.bodyFatGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bodyFatGrouped(userId: string, request: Vital.VitalsBodyFatGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBodyFatResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBloodOxygenGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bloodOxygenGrouped("user_id", {
+     *     await client.vitals.bloodOxygenGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bloodOxygenGrouped(userId: string, request: Vital.VitalsBloodOxygenGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBloodOxygenResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsElectrocardiogramVoltageGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.electrocardiogramVoltageGrouped("user_id", {
+     *     await client.vitals.electrocardiogramVoltageGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     electrocardiogramVoltageGrouped(userId: string, request: Vital.VitalsElectrocardiogramVoltageGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedElectrocardiogramVoltageResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBloodPressureGroupedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bloodPressureGrouped("user_id", {
+     *     await client.vitals.bloodPressureGrouped("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bloodPressureGrouped(userId: string, request: Vital.VitalsBloodPressureGroupedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.GroupedBloodPressureResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsVo2MaxRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.vo2Max("user_id", {
+     *     await client.vitals.vo2Max("user_id", {
      *         startDate: "start_date"
      *     })
      */
     vo2Max(userId: string, request: Vital.VitalsVo2MaxRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingVo2MaxTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsStressLevelRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.stressLevel("user_id", {
+     *     await client.vitals.stressLevel("user_id", {
      *         startDate: "start_date"
      *     })
      */
     stressLevel(userId: string, request: Vital.VitalsStressLevelRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingStressLevelTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsMindfulnessMinutesRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.mindfulnessMinutes("user_id", {
+     *     await client.vitals.mindfulnessMinutes("user_id", {
      *         startDate: "start_date"
      *     })
      */
     mindfulnessMinutes(userId: string, request: Vital.VitalsMindfulnessMinutesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingMindfulnessMinutesTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCaffeineRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.caffeine("user_id", {
+     *     await client.vitals.caffeine("user_id", {
      *         startDate: "start_date"
      *     })
      */
     caffeine(userId: string, request: Vital.VitalsCaffeineRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaffeineTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsWaterRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.water("user_id", {
+     *     await client.vitals.water("user_id", {
      *         startDate: "start_date"
      *     })
      */
     water(userId: string, request: Vital.VitalsWaterRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingWaterTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsStepsRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.steps("user_id", {
+     *     await client.vitals.steps("user_id", {
      *         startDate: "start_date"
      *     })
      */
     steps(userId: string, request: Vital.VitalsStepsRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingStepsTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsFloorsClimbedRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.floorsClimbed("user_id", {
+     *     await client.vitals.floorsClimbed("user_id", {
      *         startDate: "start_date"
      *     })
      */
     floorsClimbed(userId: string, request: Vital.VitalsFloorsClimbedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingFloorsClimbedTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsDistanceRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.distance("user_id", {
+     *     await client.vitals.distance("user_id", {
      *         startDate: "start_date"
      *     })
      */
     distance(userId: string, request: Vital.VitalsDistanceRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingDistanceTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCaloriesBasalRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.caloriesBasal("user_id", {
+     *     await client.vitals.caloriesBasal("user_id", {
      *         startDate: "start_date"
      *     })
      */
     caloriesBasal(userId: string, request: Vital.VitalsCaloriesBasalRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaloriesBasalTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCaloriesActiveRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.caloriesActive("user_id", {
+     *     await client.vitals.caloriesActive("user_id", {
      *         startDate: "start_date"
      *     })
      */
     caloriesActive(userId: string, request: Vital.VitalsCaloriesActiveRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaloriesActiveTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsRespiratoryRateRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.respiratoryRate("user_id", {
+     *     await client.vitals.respiratoryRate("user_id", {
      *         startDate: "start_date"
      *     })
      */
     respiratoryRate(userId: string, request: Vital.VitalsRespiratoryRateRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingRespiratoryRateTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsIgeRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.ige("user_id", {
+     *     await client.vitals.ige("user_id", {
      *         startDate: "start_date"
      *     })
      */
     ige(userId: string, request: Vital.VitalsIgeRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingIgeTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsIggRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.igg("user_id", {
+     *     await client.vitals.igg("user_id", {
      *         startDate: "start_date"
      *     })
      */
     igg(userId: string, request: Vital.VitalsIggRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingIggTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsHypnogramRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.hypnogram("user_id", {
+     *     await client.vitals.hypnogram("user_id", {
      *         startDate: "start_date"
      *     })
      */
     hypnogram(userId: string, request: Vital.VitalsHypnogramRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHypnogramTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsHrvRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.hrv("user_id", {
+     *     await client.vitals.hrv("user_id", {
      *         startDate: "start_date"
      *     })
      */
     hrv(userId: string, request: Vital.VitalsHrvRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHrvTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsHeartrateRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.heartrate("user_id", {
+     *     await client.vitals.heartrate("user_id", {
      *         startDate: "start_date"
      *     })
      */
     heartrate(userId: string, request: Vital.VitalsHeartrateRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHeartRateTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsGlucoseRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.glucose("user_id", {
+     *     await client.vitals.glucose("user_id", {
      *         startDate: "start_date"
      *     })
      */
     glucose(userId: string, request: Vital.VitalsGlucoseRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingGlucoseTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCholesterolTriglyceridesRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolTriglycerides("user_id", {
+     *     await client.vitals.cholesterolTriglycerides("user_id", {
      *         startDate: "start_date"
      *     })
      */
     cholesterolTriglycerides(userId: string, request: Vital.VitalsCholesterolTriglyceridesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCholesterolTotalRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolTotal("user_id", {
+     *     await client.vitals.cholesterolTotal("user_id", {
      *         startDate: "start_date"
      *     })
      */
     cholesterolTotal(userId: string, request: Vital.VitalsCholesterolTotalRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCholesterolLdlRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolLdl("user_id", {
+     *     await client.vitals.cholesterolLdl("user_id", {
      *         startDate: "start_date"
      *     })
      */
     cholesterolLdl(userId: string, request: Vital.VitalsCholesterolLdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCholesterolHdlRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterolHdl("user_id", {
+     *     await client.vitals.cholesterolHdl("user_id", {
      *         startDate: "start_date"
      *     })
      */
     cholesterolHdl(userId: string, request: Vital.VitalsCholesterolHdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsCholesterolRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.cholesterol("user_id", {
+     *     await client.vitals.cholesterol("user_id", {
      *         startDate: "start_date"
      *     })
      */
     cholesterol(userId: string, request: Vital.VitalsCholesterolRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBodyWeightRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bodyWeight("user_id", {
+     *     await client.vitals.bodyWeight("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bodyWeight(userId: string, request: Vital.VitalsBodyWeightRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBodyWeightTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBodyFatRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bodyFat("user_id", {
+     *     await client.vitals.bodyFat("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bodyFat(userId: string, request: Vital.VitalsBodyFatRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBodyFatTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBloodOxygenRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bloodOxygen("user_id", {
+     *     await client.vitals.bloodOxygen("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bloodOxygen(userId: string, request: Vital.VitalsBloodOxygenRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBloodOxygenTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsElectrocardiogramVoltageRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.electrocardiogramVoltage("user_id", {
+     *     await client.vitals.electrocardiogramVoltage("user_id", {
      *         startDate: "start_date"
      *     })
      */
     electrocardiogramVoltage(userId: string, request: Vital.VitalsElectrocardiogramVoltageRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingElectrocardiogramVoltageTimeseries[]>;
     /**
+     * @param {string} userId
+     * @param {Vital.VitalsBloodPressureRequest} request
+     * @param {Vitals.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.vitals.bloodPressure("user_id", {
+     *     await client.vitals.bloodPressure("user_id", {
      *         startDate: "start_date"
      *     })
      */
     bloodPressure(userId: string, request: Vital.VitalsBloodPressureRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBloodPressureTimeseries[]>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-vital-api-key": string;
+        "x-vital-api-key": string | undefined;
     }>;
 }