@tryvital/vital-node 2.1.21 → 3.0.0-beta.0

package/api/types/ClientFacingTestKitOrderDetails.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ClientFacingTestKitOrderDetails {
+    data?: Vital.ClientFacingTestkitOrder;
+}

package/api/types/ClientFacingTestKitOrderDetails.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingTestkitOrder.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+/**
+ * Schema for a testkit order in the client facing API.
+ *
+ * To be used as part of a ClientFacingOrder.
+ */
+export interface ClientFacingTestkitOrder {
+    /** The Vital TestKit Order ID */
+    id: string;
+    /** Shipment object */
+    shipment?: Vital.ClientFacingShipment;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/api/types/ClientFacingTestkitOrder.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingUser.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ClientFacingUser {
+    /** User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. */
+    userId: string;
+    /** Your team id. */
+    teamId: string;
+    /** A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. */
+    clientUserId: string;
+    /** When your item is created */
+    createdOn: Date;
+    /** A list of the users connected sources. */
+    connectedSources: Vital.ConnectedSourceClientFacing[];
+    /**
+     *     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/api/types/ClientFacingUser.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingUserKey.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ClientFacingUserKey {
+    /** User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. */
+    userId: string;
+    /** A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. */
+    clientUserId: string;
+}

package/api/types/ClientFacingUserKey.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingWalkInOrderDetails.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ClientFacingWalkInOrderDetails {
+    data?: Vital.ClientFacingWalkInTestOrder;
+}

package/api/types/ClientFacingWalkInOrderDetails.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingWalkInTestOrder.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for a walk-in test order in the client facing API.
+ *
+ * To be used as part of a ClientFacingOrder.
+ */
+export interface ClientFacingWalkInTestOrder {
+    /** The Vital walk-in test Order ID */
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/api/types/ClientFacingWalkInTestOrder.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingWaterTimeseries.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ClientFacingWaterTimeseries {
+    /** Deprecated */
+    id?: number;
+    /** Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. */
+    timezoneOffset?: number;
+    /** The reading type of the measurement. This is applicable only to Cholesterol, IGG and IGE. */
+    type?: string;
+    /** Measured in milliters. */
+    unit: string;
+    /** The timestamp of the measurement. */
+    timestamp: Date;
+    /** Quantity of water drank during the time period. */
+    value: number;
+}

package/api/types/ClientFacingWaterTimeseries.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientFacingWorkout.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ClientFacingWorkout {
+    /** User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. */
+    userId: string;
+    id: string;
+    /** Title given for the workout */
+    title?: string;
+    /** Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds */
+    timezoneOffset?: number;
+    /** Average heart rate during workout::bpm */
+    averageHr?: number;
+    /** Max heart rate during workout::bpm */
+    maxHr?: number;
+    /** Distance travelled during workout::meters */
+    distance?: number;
+    /** Date of the workout summary in the YYYY-mm-dd format. This generally matches the workout start date. */
+    calendarDate: string;
+    /** Start time of the workout::time */
+    timeStart: Date;
+    /** End time of the workout::time */
+    timeEnd: Date;
+    /** Calories burned during the workout::kCal */
+    calories?: number;
+    /** Sport's name */
+    sport?: Vital.ClientFacingSport;
+    /** Time in seconds spent in different heart rate zones <50%, 50-60%, 60-70%, 70-80%, 80-90%, 90%+. Due to rounding errors, it's possible that summing all values is different than the total time of the workout. Not available for all providers::seconds */
+    hrZones?: number[];
+    /** Time spent active during the workout::seconds */
+    movingTime?: number;
+    /** Elevation gain during the workout::meters */
+    totalElevationGain?: number;
+    /** Highest point of elevation::meters */
+    elevHigh?: number;
+    /** Lowest point of elevation::meters */
+    elevLow?: number;
+    /** Average speed during workout in m/s::meters/sec */
+    averageSpeed?: number;
+    /** Max speed during workout in m/s::meters/sec */
+    maxSpeed?: number;
+    /** Average watts burned during exercise::watts */
+    averageWatts?: number;
+    /** Watts burned during exercise::watts */
+    deviceWatts?: number;
+    /** Max watts burned during exercise::watts */
+    maxWatts?: number;
+    /** Weighted average watts burned during exercise::watts */
+    weightedAverageWatts?: number;
+    /** Map of workouts encoded as polyline */
+    map?: Record<string, unknown>;
+    /** Provider ID given for that specific workout */
+    providerId: string;
+    /** Source the data has come from. */
+    source: Vital.ClientFacingSource;
+}

package/api/types/ClientFacingWorkout.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientSleepResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ClientSleepResponse {
+    sleep: Vital.ClientFacingSleep[];
+}

package/api/types/ClientSleepResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ClientWorkoutResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ClientWorkoutResponse {
+    workouts: Vital.ClientFacingWorkout[];
+}

package/api/types/ClientWorkoutResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ConnectedSourceClientFacing.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface ConnectedSourceClientFacing {
+    /** The provider of this connected source. */
+    provider: Vital.ClientFacingProvider;
+    /** When your item is created */
+    createdOn: Date;
+    /** Deprecated. Use `provider` instead. Subject to removal after 1 Jan 2024. */
+    source: Vital.ClientFacingProvider;
+}

package/api/types/ConnectedSourceClientFacing.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ConnectionStatus.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConnectionStatus {
+    success: boolean;
+    redirectUrl?: string;
+}

package/api/types/ConnectionStatus.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Consent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface Consent {
+    consentType: Vital.ConsentType;
+    version?: string;
+    timeOfConsent?: Date;
+}

package/api/types/Consent.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ConsentType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An enumeration.
+ */
+export declare type ConsentType = "terms-of-use" | "telehealth-informed-consent" | "mobile-terms-and-conditions" | "notice-of-privacy-practices" | "privacy-policy" | "hipaa-authorization";
+export declare const ConsentType: {
+    readonly TermsOfUse: "terms-of-use";
+    readonly TelehealthInformedConsent: "telehealth-informed-consent";
+    readonly MobileTermsAndConditions: "mobile-terms-and-conditions";
+    readonly NoticeOfPrivacyPractices: "notice-of-privacy-practices";
+    readonly PrivacyPolicy: "privacy-policy";
+    readonly HipaaAuthorization: "hipaa-authorization";
+};

package/api/types/ConsentType.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsentType = void 0;
+exports.ConsentType = {
+    TermsOfUse: "terms-of-use",
+    TelehealthInformedConsent: "telehealth-informed-consent",
+    MobileTermsAndConditions: "mobile-terms-and-conditions",
+    NoticeOfPrivacyPractices: "notice-of-privacy-practices",
+    PrivacyPolicy: "privacy-policy",
+    HipaaAuthorization: "hipaa-authorization",
+};

package/api/types/DaySlots.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface DaySlots {
+    date: string;
+    slots: Vital.TimeSlot[];
+}

package/api/types/DaySlots.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/DemoConnectionStatus.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DemoConnectionStatus {
+    success: boolean;
+    detail: string;
+}

package/api/types/DemoConnectionStatus.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/DemoProviders.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An enumeration.
+ */
+export declare type DemoProviders = "apple_health_kit" | "fitbit" | "freestyle_libre" | "oura";
+export declare const DemoProviders: {
+    readonly AppleHealthKit: "apple_health_kit";
+    readonly Fitbit: "fitbit";
+    readonly FreestyleLibre: "freestyle_libre";
+    readonly Oura: "oura";
+};

package/api/types/DemoProviders.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DemoProviders = void 0;
+exports.DemoProviders = {
+    AppleHealthKit: "apple_health_kit",
+    Fitbit: "fitbit",
+    FreestyleLibre: "freestyle_libre",
+    Oura: "oura",
+};

package/api/types/DeviceV2InDb.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface DeviceV2InDb {
+    data?: string;
+    providerId: string;
+    userId: string;
+    sourceId: number;
+    id: string;
+    source: Vital.ClientFacingProvider;
+}

package/api/types/DeviceV2InDb.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/EmailProviders.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type EmailProviders = "freestyle_libre";

package/api/types/EmailProviders.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Energy.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Energy {
+    unit: "kcal";
+    value: number;
+}

package/api/types/Energy.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/FallbackTimeZone.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 */
+    sourceSlug: string;
+    updatedAt: Date;
+}

package/api/types/FallbackTimeZone.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Fats.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Fats {
+    /** Amount of saturated fats in grams (g) */
+    saturated?: number;
+    /** Amount of monounsaturated fats in grams (g) */
+    monounsaturated?: number;
+    /** Amount of polyunsaturated fats in grams (g) */
+    polyunsaturated?: number;
+    /** Amount of Omega-3 fatty acids in grams (g) */
+    omega3?: number;
+    /** Amount of Omega-6 fatty acids in grams (g) */
+    omega6?: number;
+    /** Total amount of fats in grams (g) */
+    total?: number;
+}

package/api/types/Fats.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Gender.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An enumeration.
+ */
+export declare type Gender = "female" | "male" | "other" | "unknown";
+export declare const Gender: {
+    readonly Female: "female";
+    readonly Male: "male";
+    readonly Other: "other";
+    readonly Unknown: "unknown";
+};

package/api/types/Gender.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gender = void 0;
+exports.Gender = {
+    Female: "female",
+    Male: "male",
+    Other: "other",
+    Unknown: "unknown",
+};

package/api/types/GetMarkersResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface GetMarkersResponse {
+    markers: Vital.ClientFacingMarker[];
+    total: number;
+    page: number;
+    size: number;
+}

package/api/types/GetMarkersResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/GetOrdersResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface GetOrdersResponse {
+    orders: Vital.ClientFacingOrder[];
+    total: number;
+    page: number;
+    size: number;
+}

package/api/types/GetOrdersResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/HealthInsuranceCreateRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+export interface HealthInsuranceCreateRequest {
+    /** An image of the front of the patient insurance card. */
+    frontImage?: Vital.HealthInsuranceCreateRequestFrontImage;
+    /** An image of the back of the patient insurance card. */
+    backImage?: Vital.HealthInsuranceCreateRequestBackImage;
+    /** An image of the patient signature for health insurance billing. */
+    patientSignatureImage?: Vital.HealthInsuranceCreateRequestPatientSignatureImage;
+    /** Textual description of what are the patient symptoms and attempted treatments. */
+    subjective?: string;
+    /** Textual description of what are the physician assessments and testing plans. */
+    assessmentPlan?: string;
+    /** Unique identifier representing a specific Health Insurance. */
+    payorCode?: string;
+    /** Insurance unique number assigned to a patient, usually present on the insurance card. */
+    insuranceId?: string;
+    /** Relationship between the patient and the insurance contractor. Values can be (Self, Spouse, Other Relationship). */
+    responsibleRelationship?: Vital.ResponsibleRelationship;
+    /** Responsible details when the value of responsible_relationship is not 'Self'. */
+    responsibleDetails?: Vital.PersonDetails;
+    /** Diagnosis codes for insurance billing. */
+    diagnosisCodes?: string[];
+}

package/api/types/HealthInsuranceCreateRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/HealthInsuranceCreateRequestBackImage.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+/**
+ * An image of the back of the patient insurance card.
+ */
+export declare type HealthInsuranceCreateRequestBackImage = Vital.HealthInsuranceCreateRequestBackImage.ImageJpeg | Vital.HealthInsuranceCreateRequestBackImage.ImagePng;
+export declare namespace HealthInsuranceCreateRequestBackImage {
+    interface ImageJpeg extends Vital.Jpeg {
+        contentType: "image/jpeg";
+    }
+    interface ImagePng extends Vital.Png {
+        contentType: "image/png";
+    }
+}

package/api/types/HealthInsuranceCreateRequestBackImage.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/HealthInsuranceCreateRequestFrontImage.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "..";
+/**
+ * An image of the front of the patient insurance card.
+ */
+export declare type HealthInsuranceCreateRequestFrontImage = Vital.HealthInsuranceCreateRequestFrontImage.ImageJpeg | Vital.HealthInsuranceCreateRequestFrontImage.ImagePng;
+export declare namespace HealthInsuranceCreateRequestFrontImage {
+    interface ImageJpeg extends Vital.Jpeg {
+        contentType: "image/jpeg";
+    }
+    interface ImagePng extends Vital.Png {
+        contentType: "image/png";
+    }
+}