@tryvital/vital-node 3.1.68 → 3.1.70

package/api/types/PhlebotomyProviderInfo.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface PhlebotomyProviderInfo {
     name: Vital.AppointmentProvider;
     serviceTypes: Vital.AppointmentServiceType[];

package/api/types/PhysicianCreateRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface PhysicianCreateRequest {
     firstName: string;
     lastName: string;

package/api/types/PhysicianCreateRequestSignatureImage.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 /**
  * An image of the physician signature for health insurance billing
  */

package/api/types/Placeholder.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Placeholder {
+    placeholder: boolean;
+}

package/api/types/Placeholder.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/PostOrderResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface PostOrderResponse {
     order: Vital.ClientFacingOrder;
     status: string;

package/api/types/ProfileInDb.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface ProfileInDb {
     data?: unknown;
     userId: string;

package/api/types/ProviderLinkResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface ProviderLinkResponse {
     state: Vital.ProviderLinkResponseState;
     redirectUrl?: string;

package/api/types/ProviderMfaRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface ProviderMfaRequest {
     method: Vital.ProviderMfaRequestMethod;
     hint: string;

package/api/types/Providers.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Providers = "oura" | "fitbit" | "garmin" | "whoop" | "strava" | "renpho" | "peloton" | "wahoo" | "zwift" | "freestyle_libre" | "abbott_libreview" | "freestyle_libre_ble" | "eight_sleep" | "withings" | "apple_health_kit" | "manual" | "ihealth" | "google_fit" | "beurer_api" | "beurer_ble" | "omron" | "omron_ble" | "onetouch_ble" | "accuchek_ble" | "contour_ble" | "dexcom" | "dexcom_v3" | "hammerhead" | "my_fitness_pal" | "health_connect" | "polar" | "cronometer" | "kardia" | "whoop_v2";
+export declare type Providers = "oura" | "fitbit" | "garmin" | "whoop" | "strava" | "renpho" | "peloton" | "wahoo" | "zwift" | "freestyle_libre" | "abbott_libreview" | "freestyle_libre_ble" | "eight_sleep" | "withings" | "apple_health_kit" | "manual" | "ihealth" | "google_fit" | "beurer_api" | "beurer_ble" | "omron" | "omron_ble" | "onetouch_ble" | "accuchek_ble" | "contour_ble" | "dexcom" | "dexcom_v3" | "hammerhead" | "my_fitness_pal" | "health_connect" | "polar" | "cronometer" | "kardia" | "whoop_v2" | "ultrahuman";
 export declare const Providers: {
     readonly Oura: "oura";
     readonly Fitbit: "fitbit";
@@ -37,4 +37,5 @@ export declare const Providers: {
     readonly Cronometer: "cronometer";
     readonly Kardia: "kardia";
     readonly WhoopV2: "whoop_v2";
+    readonly Ultrahuman: "ultrahuman";
 };

package/api/types/Providers.js

@@ -39,4 +39,5 @@ exports.Providers = {
     Cronometer: "cronometer",
     Kardia: "kardia",
     WhoopV2: "whoop_v2",
+    Ultrahuman: "ultrahuman",
 };

package/api/types/PscAreaInfo.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface PscAreaInfo {
     patientServiceCenters: Vital.PscAreaInfoDetails;
     supportedBillTypes: Vital.Billing[];

package/api/types/PscInfo.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface PscInfo {
     labId: number;
     slug: Vital.Labs;

package/api/types/QueryConfig.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export interface QueryConfig {
+    weekStartsOn?: Vital.QueryConfigWeekStartsOn;
+    providerPriorityOverrides?: Vital.QueryConfigProviderPriorityOverridesItem[];
+}

package/api/types/QueryConfig.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/QueryConfigProviderPriorityOverridesItem.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export declare type QueryConfigProviderPriorityOverridesItem = Vital.Providers | Vital.Labs;

package/api/types/QueryConfigProviderPriorityOverridesItem.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/QueryConfigWeekStartsOn.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type QueryConfigWeekStartsOn = "sunday" | "monday";
+export declare const QueryConfigWeekStartsOn: {
+    readonly Sunday: "sunday";
+    readonly Monday: "monday";
+};

package/api/types/QueryConfigWeekStartsOn.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryConfigWeekStartsOn = void 0;
+exports.QueryConfigWeekStartsOn = {
+    Sunday: "sunday",
+    Monday: "monday",
+};

package/api/types/QueryInstruction.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export interface QueryInstruction {
+    select: Vital.QueryInstructionSelect;
+    partitionBy: Vital.QueryInstructionPartitionBy;
+    swizzleBy?: Vital.Swizzling;
+    reduceBy: Vital.Reducer[];
+    splitBySource?: boolean;
+}

package/api/types/QueryInstruction.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/QueryInstructionPartitionBy.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export declare type QueryInstructionPartitionBy = Vital.Period | Vital.Placeholder;

package/api/types/QueryInstructionPartitionBy.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/QueryInstructionSelect.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export declare type QueryInstructionSelect = Vital.SleepSelector | Vital.ActivitySelector;

package/api/types/QueryInstructionSelect.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/Question.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface Question {
     id: number;
     required: boolean;

package/api/types/RawActivity.d.ts

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

package/api/types/RawBody.d.ts

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

package/api/types/RawDevices.d.ts

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

package/api/types/RawProfile.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface RawProfile {
     profile: Vital.ProfileInDb;
 }

package/api/types/RawSleep.d.ts

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

package/api/types/RawWorkout.d.ts

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

package/api/types/Reducer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export interface Reducer {
+    function: Vital.ReducerFunction;
+}

package/api/types/Reducer.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/ReducerFunction.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ReducerFunction = "mean" | "min" | "max" | "sum" | "count" | "median" | "stddev" | "oldest" | "newest";
+export declare const ReducerFunction: {
+    readonly Mean: "mean";
+    readonly Min: "min";
+    readonly Max: "max";
+    readonly Sum: "sum";
+    readonly Count: "count";
+    readonly Median: "median";
+    readonly Stddev: "stddev";
+    readonly Oldest: "oldest";
+    readonly Newest: "newest";
+};

package/api/types/ReducerFunction.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReducerFunction = void 0;
+exports.ReducerFunction = {
+    Mean: "mean",
+    Min: "min",
+    Max: "max",
+    Sum: "sum",
+    Count: "count",
+    Median: "median",
+    Stddev: "stddev",
+    Oldest: "oldest",
+    Newest: "newest",
+};

package/api/types/RelativeTimeframe.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+export interface RelativeTimeframe {
+    type: "relative";
+    anchor: string;
+    past: Vital.Period;
+}

package/api/types/RelativeTimeframe.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/ResourceAvailability.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface ResourceAvailability {
     status: Vital.Availability;
     scopeRequirements?: Vital.ScopeRequirementsGrants;

package/api/types/ScopeRequirementsGrants.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface ScopeRequirementsGrants {
     userGranted: Vital.ScopeRequirementsStr;
     userDenied: Vital.ScopeRequirementsStr;

package/api/types/SingleHistoricalPullStatistics.d.ts

@@ -1,11 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SingleHistoricalPullStatistics {
     status: Vital.HistoricalPullStatus;
-    rangeStart?: Date;
-    rangeEnd?: Date;
+    rangeStart?: string;
+    rangeEnd?: string;
     timeline: Vital.HistoricalPullTimeline;
     daysWithData?: number;
     release: string;

package/api/types/SingleProviderHistoricalPullResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SingleProviderHistoricalPullResponse {
     pulled: Record<string, Vital.SingleHistoricalPullStatistics>;
     notPulled: Vital.ClientFacingResource[];

package/api/types/SingleResourceStatistics.d.ts

@@ -1,10 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SingleResourceStatistics {
     lastAttempt?: Vital.LastAttempt;
-    oldestData?: Date;
-    newestData?: Date;
+    oldestData?: string;
+    newestData?: string;
     sentCount?: number;
 }

package/api/types/SingleUserHistoricalPullResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SingleUserHistoricalPullResponse {
     userId: string;
     provider: Record<string, Vital.SingleProviderHistoricalPullResponse>;

package/api/types/SingleUserResourceResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SingleUserResourceResponse {
     userId: string;
     provider: Record<string, Record<string, Vital.SingleResourceStatistics>>;

package/api/types/SleepSelector.d.ts

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

package/api/types/SleepSelector.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/SleepSelectorSleep.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type SleepSelectorSleep = "session_start" | "session_end" | "state" | "duration_second" | "stage_asleep_second" | "stage_awake_second" | "stage_light_second" | "stage_rem_second" | "stage_deep_second" | "stage_unknown_second" | "latency_second" | "heart_rate_minimum" | "heart_rate_mean" | "heart_rate_maximum" | "heart_rate_dip" | "efficiency" | "hrv_mean_rmssd" | "hrv_mean_sdnn" | "skin_temperature_delta" | "respiratory_rate" | "score" | "source_type" | "source_provider" | "source_app_id";
+export declare const SleepSelectorSleep: {
+    readonly SessionStart: "session_start";
+    readonly SessionEnd: "session_end";
+    readonly State: "state";
+    readonly DurationSecond: "duration_second";
+    readonly StageAsleepSecond: "stage_asleep_second";
+    readonly StageAwakeSecond: "stage_awake_second";
+    readonly StageLightSecond: "stage_light_second";
+    readonly StageRemSecond: "stage_rem_second";
+    readonly StageDeepSecond: "stage_deep_second";
+    readonly StageUnknownSecond: "stage_unknown_second";
+    readonly LatencySecond: "latency_second";
+    readonly HeartRateMinimum: "heart_rate_minimum";
+    readonly HeartRateMean: "heart_rate_mean";
+    readonly HeartRateMaximum: "heart_rate_maximum";
+    readonly HeartRateDip: "heart_rate_dip";
+    readonly Efficiency: "efficiency";
+    readonly HrvMeanRmssd: "hrv_mean_rmssd";
+    readonly HrvMeanSdnn: "hrv_mean_sdnn";
+    readonly SkinTemperatureDelta: "skin_temperature_delta";
+    readonly RespiratoryRate: "respiratory_rate";
+    readonly Score: "score";
+    readonly SourceType: "source_type";
+    readonly SourceProvider: "source_provider";
+    readonly SourceAppId: "source_app_id";
+};

package/api/types/SleepSelectorSleep.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SleepSelectorSleep = void 0;
+exports.SleepSelectorSleep = {
+    SessionStart: "session_start",
+    SessionEnd: "session_end",
+    State: "state",
+    DurationSecond: "duration_second",
+    StageAsleepSecond: "stage_asleep_second",
+    StageAwakeSecond: "stage_awake_second",
+    StageLightSecond: "stage_light_second",
+    StageRemSecond: "stage_rem_second",
+    StageDeepSecond: "stage_deep_second",
+    StageUnknownSecond: "stage_unknown_second",
+    LatencySecond: "latency_second",
+    HeartRateMinimum: "heart_rate_minimum",
+    HeartRateMean: "heart_rate_mean",
+    HeartRateMaximum: "heart_rate_maximum",
+    HeartRateDip: "heart_rate_dip",
+    Efficiency: "efficiency",
+    HrvMeanRmssd: "hrv_mean_rmssd",
+    HrvMeanSdnn: "hrv_mean_sdnn",
+    SkinTemperatureDelta: "skin_temperature_delta",
+    RespiratoryRate: "respiratory_rate",
+    Score: "score",
+    SourceType: "source_type",
+    SourceProvider: "source_provider",
+    SourceAppId: "source_app_id",
+};

package/api/types/SleepV2InDb.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SleepV2InDb {
     timestamp: Date;
     data: Record<string, unknown>;

package/api/types/Source.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface Source {
     name: string;
     slug: string;

package/api/types/SourceLink.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vital from "..";
+import * as Vital from "../index";
 export interface SourceLink {
     id: number;
     name: string;

package/api/types/Swizzling.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vital from "../index";
+/**
+ * The Swizzling mode makes the reducer functions produce statistics
+ * based on X-of-Y granularity (e.g., day-of-week) for each and every data partition.
+ *
+ * ## Basic usages
+ *
+ * - Hour of Day — gather_every={1, hour}, bin_granularity=day, bin_count=1
+ * - Day of Week — gather_every={1, day}, bin_granularity=week, bin_count=1
+ * - Day of Month — gather_every={1, day}, bin_granularity=month, bin_count=1
+ *
+ * ## Output columns
+ *
+ * Swizzling mode adds two additional columns to the output dataframes:
+ *
+ * 1. `swizzle_bin`: The bin index of the data point post-binning (with respect to `bin_count`
+ *    and `bin_granularity); and 2 `swizzle_period_start`: The bin-relative period start of the data point with respect to `gather_every`.
+ *
+ * ## Supported combinations
+ *
+ * | gather_every | group_by          |
+ * | ------------ | ----------------- |
+ * | minute       | minute, hour, day |
+ * | hour         | hour, day, week   |
+ * | day          | day, week, month  |
+ * | week         | week, month       |
+ * | month        | month             |
+ */
+export interface Swizzling {
+    binGranularity: Vital.SwizzlingBinGranularity;
+    binCount?: number;
+    gatherEvery: Vital.Period;
+}

package/api/types/Swizzling.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/SwizzlingBinGranularity.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type SwizzlingBinGranularity = "minute" | "hour" | "day" | "week" | "month";
+export declare const SwizzlingBinGranularity: {
+    readonly Minute: "minute";
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};

package/api/types/SwizzlingBinGranularity.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwizzlingBinGranularity = void 0;
+exports.SwizzlingBinGranularity = {
+    Minute: "minute",
+    Hour: "hour",
+    Day: "day",
+    Week: "week",
+    Month: "month",
+};