npm - @tryvital/vital-node - Versions diffs - 3.1.7 → 3.1.8 - Mend

@tryvital/vital-node 3.1.7 → 3.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (335) hide show

package/api/resources/vitals/client/requests/VitalsBloodOxygenGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBloodOxygenGroupedRequest {

package/api/resources/vitals/client/requests/VitalsBloodOxygenRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBloodOxygenRequest {

package/api/resources/vitals/client/requests/VitalsBloodPressureGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBloodPressureGroupedRequest {

package/api/resources/vitals/client/requests/VitalsBloodPressureRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBloodPressureRequest {

package/api/resources/vitals/client/requests/VitalsBodyFatGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBodyFatGroupedRequest {

package/api/resources/vitals/client/requests/VitalsBodyFatRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBodyFatRequest {

package/api/resources/vitals/client/requests/VitalsBodyWeightGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBodyWeightGroupedRequest {

package/api/resources/vitals/client/requests/VitalsBodyWeightRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsBodyWeightRequest {

package/api/resources/vitals/client/requests/VitalsCaffeineGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCaffeineGroupedRequest {

package/api/resources/vitals/client/requests/VitalsCaffeineRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCaffeineRequest {

package/api/resources/vitals/client/requests/VitalsCaloriesActiveGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCaloriesActiveGroupedRequest {

package/api/resources/vitals/client/requests/VitalsCaloriesActiveRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCaloriesActiveRequest {

package/api/resources/vitals/client/requests/VitalsCaloriesBasalGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCaloriesBasalGroupedRequest {

package/api/resources/vitals/client/requests/VitalsCaloriesBasalRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCaloriesBasalRequest {

package/api/resources/vitals/client/requests/VitalsCholesterolGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCholesterolGroupedRequest {

package/api/resources/vitals/client/requests/VitalsCholesterolHdlRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCholesterolHdlRequest {

package/api/resources/vitals/client/requests/VitalsCholesterolLdlRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCholesterolLdlRequest {

package/api/resources/vitals/client/requests/VitalsCholesterolRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCholesterolRequest {

package/api/resources/vitals/client/requests/VitalsCholesterolTotalRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCholesterolTotalRequest {

package/api/resources/vitals/client/requests/VitalsCholesterolTriglyceridesRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsCholesterolTriglyceridesRequest {

package/api/resources/vitals/client/requests/VitalsDistanceGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsDistanceGroupedRequest {

package/api/resources/vitals/client/requests/VitalsDistanceRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsDistanceRequest {

package/api/resources/vitals/client/requests/VitalsElectrocardiogramVoltageGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsElectrocardiogramVoltageGroupedRequest {

package/api/resources/vitals/client/requests/VitalsElectrocardiogramVoltageRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsElectrocardiogramVoltageRequest {

package/api/resources/vitals/client/requests/VitalsFloorsClimbedGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsFloorsClimbedGroupedRequest {

package/api/resources/vitals/client/requests/VitalsFloorsClimbedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsFloorsClimbedRequest {

package/api/resources/vitals/client/requests/VitalsGlucoseGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsGlucoseGroupedRequest {

package/api/resources/vitals/client/requests/VitalsGlucoseRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsGlucoseRequest {

package/api/resources/vitals/client/requests/VitalsHeartrateGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsHeartrateGroupedRequest {

package/api/resources/vitals/client/requests/VitalsHeartrateRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsHeartrateRequest {

package/api/resources/vitals/client/requests/VitalsHrvGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsHrvGroupedRequest {

package/api/resources/vitals/client/requests/VitalsHrvRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsHrvRequest {

package/api/resources/vitals/client/requests/VitalsHypnogramGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsHypnogramGroupedRequest {

package/api/resources/vitals/client/requests/VitalsHypnogramRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsHypnogramRequest {

package/api/resources/vitals/client/requests/VitalsIgeGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsIgeGroupedRequest {

package/api/resources/vitals/client/requests/VitalsIgeRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsIgeRequest {

package/api/resources/vitals/client/requests/VitalsIggGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsIggGroupedRequest {

package/api/resources/vitals/client/requests/VitalsIggRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsIggRequest {

package/api/resources/vitals/client/requests/VitalsMindfulnessMinutesGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsMindfulnessMinutesGroupedRequest {

package/api/resources/vitals/client/requests/VitalsMindfulnessMinutesRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsMindfulnessMinutesRequest {

package/api/resources/vitals/client/requests/VitalsRespiratoryRateGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsRespiratoryRateGroupedRequest {

package/api/resources/vitals/client/requests/VitalsRespiratoryRateRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsRespiratoryRateRequest {

package/api/resources/vitals/client/requests/VitalsStepsGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsStepsGroupedRequest {

package/api/resources/vitals/client/requests/VitalsStepsRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsStepsRequest {

package/api/resources/vitals/client/requests/VitalsStressLevelGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsStressLevelGroupedRequest {

package/api/resources/vitals/client/requests/VitalsStressLevelRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsStressLevelRequest {

package/api/resources/vitals/client/requests/VitalsVo2MaxGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsVo2MaxGroupedRequest {

package/api/resources/vitals/client/requests/VitalsVo2MaxRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsVo2MaxRequest {

package/api/resources/vitals/client/requests/VitalsWaterGroupedRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsWaterGroupedRequest {

package/api/resources/vitals/client/requests/VitalsWaterRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface VitalsWaterRequest {

package/api/resources/workouts/client/Client.d.ts CHANGED Viewed

@@ -22,8 +22,8 @@ export declare class Workouts {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.workouts.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.workouts.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId: string, request: Vital.WorkoutsGetRequest, requestOptions?: Workouts.RequestOptions): Promise<Vital.ClientWorkoutResponse>;
@@ -32,8 +32,8 @@ export declare class Workouts {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.workouts.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.workouts.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId: string, request: Vital.WorkoutsGetRawRequest, requestOptions?: Workouts.RequestOptions): Promise<Vital.RawWorkout>;
@@ -41,7 +41,7 @@ export declare class Workouts {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.workouts.getByWorkoutId("workout-id")
+     *     await vital.workouts.getByWorkoutId("workout_id")
      */
     getByWorkoutId(workoutId: string, requestOptions?: Workouts.RequestOptions): Promise<Vital.ClientFacingStream>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/api/resources/workouts/client/Client.js CHANGED Viewed

@@ -54,8 +54,8 @@ class Workouts {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.workouts.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.workouts.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId, request, requestOptions) {
@@ -73,7 +73,7 @@ class Workouts {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/workouts/${userId}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -123,8 +123,8 @@ class Workouts {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.workouts.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.workouts.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId, request, requestOptions) {
@@ -142,7 +142,7 @@ class Workouts {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/workouts/${userId}/raw`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -191,7 +191,7 @@ class Workouts {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.workouts.getByWorkoutId("workout-id")
+     *     await vital.workouts.getByWorkoutId("workout_id")
      */
     getByWorkoutId(workoutId, requestOptions) {
         var _a;
@@ -199,7 +199,7 @@ class Workouts {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/timeseries/workouts/${workoutId}/stream`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,

package/api/resources/workouts/client/requests/WorkoutsGetRawRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface WorkoutsGetRawRequest {

package/api/resources/workouts/client/requests/WorkoutsGetRequest.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface WorkoutsGetRequest {

package/api/types/AppointmentType.d.ts CHANGED Viewed

@@ -1,4 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * An enumeration.
+ */
 export declare type AppointmentType = "phlebotomy";

package/api/types/ClientFacingCaloriesActiveTimeseries.d.ts CHANGED Viewed

@@ -8,6 +8,7 @@ export interface ClientFacingCaloriesActiveTimeseries {
     timezoneOffset?: number;
     /** The reading type of the measurement. This is applicable only to Cholesterol, IGG and IGE. */
     type?: string;
+    /** Measured in kilocalories (kcal) */
     unit: "kcal";
     /** Depracated. The start time (inclusive) of the interval. */
     timestamp: Date;