@tryvital/vital-node 3.0.7 → 3.0.8

package/dist/api/resources/vitals/client/requests/VitalsBloodOxygenRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsBloodOxygenRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsBloodPressureRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsBloodPressureRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCaffeineRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCaffeineRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCaloriesActiveRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCaloriesActiveRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCaloriesBasalRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCaloriesBasalRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCholesterolHdlRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCholesterolHdlRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCholesterolLdlRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCholesterolLdlRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCholesterolRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCholesterolRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsCholesterolTotalRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsCholesterolTotalRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsDistanceRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsDistanceRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsElectrocardiogramVoltageRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsElectrocardiogramVoltageRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsFloorsClimbedRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsFloorsClimbedRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsGlucoseRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsGlucoseRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsHeartrateRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsHeartrateRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsHrvRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsHrvRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsHypnogramRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsHypnogramRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsIgeRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsIgeRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsIggRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsIggRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsMindfulnessMinutesRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsMindfulnessMinutesRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsRespiratoryRateRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsRespiratoryRateRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsStepsRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsStepsRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsTriglyceridesRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsTriglyceridesRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/vitals/client/requests/VitalsWaterRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface VitalsWaterRequest {
     /**
      * Provider oura/strava etc

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

@@ -11,6 +11,7 @@ export declare namespace Workouts {
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
+        maxRetries?: number;
     }
 }
 export declare class Workouts {
@@ -19,15 +20,28 @@ export declare class Workouts {
     /**
      * Get Daily workout for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.workouts.get("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     get(userId: string, request: Vital.WorkoutsGetRequest, requestOptions?: Workouts.RequestOptions): Promise<Vital.ClientWorkoutResponse>;
     /**
      * Get Daily workout for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.workouts.getRaw("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     getRaw(userId: string, request: Vital.WorkoutsGetRawRequest, requestOptions?: Workouts.RequestOptions): Promise<Vital.RawWorkout>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.workouts.getByWorkoutId("workout-id")
      */
     getByWorkoutId(workoutId: string, requestOptions?: Workouts.RequestOptions): Promise<Vital.ClientFacingStream>;
 }

package/dist/api/resources/workouts/client/Client.js

@@ -42,7 +42,6 @@ exports.Workouts = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const Vital = __importStar(require("../../.."));
-const url_search_params_1 = __importDefault(require("@ungap/url-search-params"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization"));
 const errors = __importStar(require("../../../../errors"));
@@ -53,18 +52,23 @@ class Workouts {
     /**
      * Get Daily workout for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.workouts.get("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     get(userId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { provider, startDate, endDate } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (provider != null) {
-                _queryParams.append("provider", provider);
+                _queryParams["provider"] = provider;
             }
-            _queryParams.append("start_date", startDate);
+            _queryParams["start_date"] = startDate;
             if (endDate != null) {
-                _queryParams.append("end_date", endDate);
+                _queryParams["end_date"] = endDate;
             }
             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}`),
@@ -73,11 +77,12 @@ class Workouts {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.8",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.ClientWorkoutResponse.parseOrThrow(_response.body, {
@@ -121,18 +126,23 @@ class Workouts {
     /**
      * Get Daily workout for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.workouts.getRaw("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     getRaw(userId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { provider, startDate, endDate } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (provider != null) {
-                _queryParams.append("provider", provider);
+                _queryParams["provider"] = provider;
             }
-            _queryParams.append("start_date", startDate);
+            _queryParams["start_date"] = startDate;
             if (endDate != null) {
-                _queryParams.append("end_date", endDate);
+                _queryParams["end_date"] = endDate;
             }
             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`),
@@ -141,11 +151,12 @@ class Workouts {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.8",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.RawWorkout.parseOrThrow(_response.body, {
@@ -188,6 +199,9 @@ class Workouts {
     }
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.workouts.getByWorkoutId("workout-id")
      */
     getByWorkoutId(workoutId, requestOptions) {
         var _a;
@@ -199,10 +213,11 @@ class Workouts {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.8",
                 },
                 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,
             });
             if (_response.ok) {
                 return yield serializers.ClientFacingStream.parseOrThrow(_response.body, {

package/dist/api/resources/workouts/client/requests/WorkoutsGetRawRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface WorkoutsGetRawRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/workouts/client/requests/WorkoutsGetRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface WorkoutsGetRequest {
     /**
      * Provider oura/strava etc

package/dist/api/types/ClientFacingDiagnosisInformation.d.ts

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ClientFacingDiagnosisInformation {
-    /** Diagnosis code for insurance information required by Labcorp. */
+    /** Diagnosis code for insurance information. */
     diagnosisCode: string;
-    /** Diagnosis description insurance information required by Labcorp. */
+    /** Diagnosis description insurance information. */
     description: string;
 }

package/dist/api/types/ClientFacingLabTest.d.ts

@@ -12,7 +12,7 @@ export interface ClientFacingLabTest {
     /** Deprecated. Use status instead. */
     isActive: boolean;
     status: Vital.LabTestStatus;
-    /** Defines whether a lab test requires fasting. Only available for Labcorp. */
+    /** Defines whether a lab test requires fasting. */
     fasting?: boolean;
     lab?: Vital.ClientFacingLab;
     markers?: Vital.ClientFacingMarker[];

package/dist/api/types/ClientFacingOrder.d.ts

@@ -31,7 +31,7 @@ export interface ClientFacingOrder {
     healthInsuranceId?: string;
     /** DEPRECATED. Requistion form url. */
     requisitionFormUrl?: string;
-    /** Defines whether order is priority or not. Only available for Labcorp. For Labcorp, this corresponds to a STAT order. */
+    /** Defines whether order is priority or not. For some labs, this refers to a STAT order. */
     priority?: boolean;
     /** Shipping Details. For unregistered testkit orders. */
     shippingDetails?: Vital.ShippingAddress;

package/dist/api/types/ClientFacingPayorSearchResponse.d.ts

@@ -3,10 +3,10 @@
  */
 import * as Vital from "..";
 export interface ClientFacingPayorSearchResponse {
-    /** Payor code returned for the insurance information required by Labcorp. */
+    /** Payor code returned for the insurance information. */
     code: string;
-    /** Insurance name returned for the insurance information required by Labcorp. */
+    /** Insurance name returned for the insurance information. */
     name: string;
-    /** Insurance business address returned for the insurance information required by Labcorp. */
+    /** Insurance business address returned for the insurance information. */
     orgAddress: Vital.Address;
 }

package/dist/api/types/ClientFacingSleep.d.ts

@@ -34,7 +34,7 @@ export interface ClientFacingSleep {
     hrLowest?: number;
     /** The average heart rate registered during the sleep period::beats per minute */
     hrAverage?: number;
-    /** Sleep efficiency is the percentage of the sleep period spent asleep (100% * sleep.total / sleep.duration)::perc */
+    /** Sleep efficiency is the percentage of the sleep period spent asleep (100% \* sleep.total / sleep.duration)::perc */
     efficiency?: number;
     /** Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep::seconds */
     latency?: number;

package/dist/api/types/ClientFacingUser.d.ts

@@ -16,7 +16,6 @@ export interface ClientFacingUser {
     /**
      *     Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
      *     Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
-     *
      */
     fallbackTimeZone?: Vital.FallbackTimeZone;
 }

package/dist/api/types/FallbackTimeZone.d.ts

@@ -5,7 +5,6 @@ export interface FallbackTimeZone {
     /**
      *     Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
      *     Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
-     *
      */
     id: string;
     /** Slug for designated source */

package/dist/api/types/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./UsAddress";
 export * from "./ActivityV2InDb";
 export * from "./Address";
 export * from "./AppointmentAvailabilitySlots";
@@ -47,8 +46,8 @@ export * from "./ClientFacingMarker";
 export * from "./ClientFacingMarkerComplete";
 export * from "./ClientFacingMealResponse";
 export * from "./ClientFacingMindfulnessMinutesTimeseries";
-export * from "./ClientFacingOrder";
 export * from "./ClientFacingOrderDetails";
+export * from "./ClientFacingOrder";
 export * from "./ClientFacingOrderEvent";
 export * from "./ClientFacingPatientDetailsCompatible";
 export * from "./ClientFacingPayorSearchResponse";
@@ -89,24 +88,24 @@ export * from "./DemoProviders";
 export * from "./DeviceV2InDb";
 export * from "./EmailProviders";
 export * from "./Energy";
-export * from "./EventDestinationPreferences";
 export * from "./EventDestinationPreferencesPreferred";
 export * from "./EventDestinationPreferencesEnabledItem";
+export * from "./EventDestinationPreferences";
 export * from "./FallbackTimeZone";
 export * from "./Fats";
 export * from "./Gender";
 export * from "./GetMarkersResponse";
 export * from "./GetOrdersResponse";
 export * from "./HttpValidationError";
-export * from "./HealthInsuranceCreateRequest";
 export * from "./HealthInsuranceCreateRequestFrontImage";
 export * from "./HealthInsuranceCreateRequestBackImage";
 export * from "./HealthInsuranceCreateRequestPatientSignatureImage";
+export * from "./HealthInsuranceCreateRequest";
 export * from "./HistoricalPullStatus";
 export * from "./Jpeg";
 export * from "./LabResultsMetadata";
-export * from "./LabResultsRaw";
 export * from "./LabResultsRawResults";
+export * from "./LabResultsRaw";
 export * from "./LabTestCollectionMethod";
 export * from "./LabTestSampleType";
 export * from "./LabTestStatus";
@@ -130,8 +129,8 @@ export * from "./PatientDetails";
 export * from "./PersonDetails";
 export * from "./PhlebotomyAreaInfo";
 export * from "./PhlebotomyProviderInfo";
-export * from "./PhysicianCreateRequest";
 export * from "./PhysicianCreateRequestSignatureImage";
+export * from "./PhysicianCreateRequest";
 export * from "./PhysicianCreateRequestBase";
 export * from "./Png";
 export * from "./PostOrderResponse";
@@ -162,13 +161,14 @@ export * from "./TeamConfig";
 export * from "./TimeSlot";
 export * from "./TimeseriesMetricPoint";
 export * from "./TimeseriesResource";
+export * from "./UsAddress";
 export * from "./UserHistoricalPullsResponse";
 export * from "./UserRefreshErrorResponse";
 export * from "./UserRefreshSuccessResponse";
 export * from "./UserResourcesResponse";
 export * from "./UserSignInTokenResponse";
 export * from "./UserSuccessResponse";
-export * from "./ValidationError";
 export * from "./ValidationErrorLocItem";
+export * from "./ValidationError";
 export * from "./VitalTokenCreatedResponse";
 export * from "./WorkoutV2InDb";