@tryvital/vital-node 3.0.7 → 3.0.9

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

@@ -11,6 +11,7 @@ export declare namespace Vitals {
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
+        maxRetries?: number;
     }
 }
 export declare class Vitals {
@@ -19,116 +20,231 @@ export declare class Vitals {
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.mindfulnessMinutes("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     mindfulnessMinutes(userId: string, request: Vital.VitalsMindfulnessMinutesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingMindfulnessMinutesTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.caffeine("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     caffeine(userId: string, request: Vital.VitalsCaffeineRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaffeineTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.water("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     water(userId: string, request: Vital.VitalsWaterRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingWaterTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.steps("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     steps(userId: string, request: Vital.VitalsStepsRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingStepsTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.floorsClimbed("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     floorsClimbed(userId: string, request: Vital.VitalsFloorsClimbedRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingFloorsClimbedTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.distance("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     distance(userId: string, request: Vital.VitalsDistanceRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingDistanceTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.caloriesBasal("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     caloriesBasal(userId: string, request: Vital.VitalsCaloriesBasalRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaloriesBasalTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.caloriesActive("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     caloriesActive(userId: string, request: Vital.VitalsCaloriesActiveRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCaloriesActiveTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.respiratoryRate("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     respiratoryRate(userId: string, request: Vital.VitalsRespiratoryRateRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingRespiratoryRateTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.ige("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     ige(userId: string, request: Vital.VitalsIgeRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingIgeTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.igg("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     igg(userId: string, request: Vital.VitalsIggRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingIggTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.hypnogram("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     hypnogram(userId: string, request: Vital.VitalsHypnogramRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHypnogramTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.hrv("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     hrv(userId: string, request: Vital.VitalsHrvRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHrvTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.heartrate("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     heartrate(userId: string, request: Vital.VitalsHeartrateRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingHeartRateTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.glucose("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     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", {
+     *         startDate: "start-date"
+     *     })
      */
     triglycerides(userId: string, request: Vital.VitalsTriglyceridesRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.cholesterolTotal("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     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", {
+     *         startDate: "start-date"
+     *     })
      */
     cholesterolHdl(userId: string, request: Vital.VitalsCholesterolHdlRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingCholesterolTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.cholesterolLdl("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     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.cholesterol("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     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.bloodOxygen("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     bloodOxygen(userId: string, request: Vital.VitalsBloodOxygenRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBloodOxygenTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.electrocardiogramVoltage("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     electrocardiogramVoltage(userId: string, request: Vital.VitalsElectrocardiogramVoltageRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingElectrocardiogramVoltageTimeseries[]>;
     /**
      * Get timeseries data for user
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.vitals.bloodPressure("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     bloodPressure(userId: string, request: Vital.VitalsBloodPressureRequest, requestOptions?: Vitals.RequestOptions): Promise<Vital.ClientFacingBloodPressureTimeseries[]>;
 }