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

package/client/models/lab_tests_model.ts

@@ -1,217 +0,0 @@
-import { USAddress } from './athome_phlebotomy_models';
-
-export type ConsentType =
-  | 'terms-of-use'
-  | 'telehealth-informed-consent'
-  | 'mobile-terms-and-conditions'
-  | 'notice-of-privacy-practices'
-  | 'privacy-policy'
-  | 'hipaa-authorization';
-
-export type Consent = {
-  consentType: ConsentType;
-};
-
-export interface ShippingDetails {
-  receiver_name: string;
-  city: string;
-  state: string;
-  zip: string;
-  country: string;
-  first_line: string;
-  second_line?: string;
-  phone_number: string;
-}
-export interface PatientAdress {
-  receiver_name: string;
-  city: string;
-  state: string;
-  zip: string;
-  country: string;
-  first_line: string;
-  second_line?: string;
-}
-
-export interface PatientDetails {
-  dob: string;
-  gender: string;
-  email?: string;
-  first_name: string;
-  phone_number: string;
-  last_name: string;
-}
-
-export interface HealthInsurance {
-  front_image: Image;
-  back_image: Image;
-}
-
-export interface Image {
-  content: string;
-  content_type: 'image/jpeg' | 'image/jpg' | 'image/png';
-}
-
-export interface Physician {
-  first_name: string;
-  last_name: string;
-  npi: string;
-}
-
-export interface Marker {
-  name: string;
-  slug: string;
-  description?: string;
-}
-
-export interface Testkit {
-  id: string;
-  name: string;
-  description: string;
-  markers: Marker[];
-  turnaround_time_lower: number;
-  turnaround_time_upper: number;
-  price: number;
-}
-
-export interface TestkitEvent {
-  id: number;
-  created_at: string;
-  status: string;
-}
-
-export interface PayorAddress {
-  city: string;
-  state: string;
-  zip: string;
-  country: string;
-  first_line: string;
-}
-
-export interface Payor {
-  code: string;
-  name: string;
-  org_address: PayorAddress;
-}
-
-export interface Diagnosis {
-  diagnosis_code: string;
-  description: string;
-}
-
-export interface Order {
-  user_id: string;
-  id: string;
-  team_id: string;
-  patient_details: PatientDetails;
-  patient_address: PatientAdress;
-  physician: Physician;
-  lab_test: Testkit;
-  // TODO  CHECK WHAT DETAILS IS
-  details: Object;
-  created_at: string;
-  updated_at: string;
-  events: TestkitEvent;
-  user_key?: string;
-  sample_id?: string;
-  notes?: string;
-  status?:
-    | 'ordered'
-    | 'transit_customer'
-    | 'out_for_delivery'
-    | 'with_customer'
-    | 'transit_lab'
-    | 'delivered_to_lab'
-    | 'processing_lab'
-    | 'completed'
-    | 'failure_to_deliver_to_customer'
-    | 'failure_to_deliver_to_lab'
-    | 'cancelled'
-    | 'do_not_process'
-    | 'unknown'
-    | 'rejected'
-    | 'lost';
-}
-
-export interface OrderRequestResponse {
-  order: Order;
-  status: string;
-  message: string;
-}
-
-export interface LabClientFacing {
-  slug: string;
-  name: string;
-  first_line_address: string;
-  city: string;
-  zipcode: string;
-}
-
-export interface ClientFacingLabTest {
-  id: string;
-  slug: string;
-  name: string;
-  sample_type: string;
-  method: string;
-  price: number;
-  is_active: boolean;
-  lab: LabClientFacing;
-  markers: Marker;
-}
-export interface TestkitResponse {
-  testkits: Testkit[];
-}
-
-export interface LabResultsMetadata {
-  age: string;
-  dob: string;
-  patient: string;
-  date_reported: string;
-  date_collected: string;
-  specimen_number: string;
-  clia?: string;
-  provider?: string;
-  laboratory?: string;
-  date_received?: string;
-}
-
-export interface LabResultsResponse {
-  metadata: LabResultsMetadata;
-  results: Result[];
-}
-
-export enum Interpretation {
-  NORMAL = 'normal',
-  ABNORMAL = 'abnormal',
-  CRITICAL = 'critical',
-}
-
-export enum ResultType {
-  NUMERIC = 'numeric',
-  RANGE = 'range',
-  COMMENT = 'comment',
-}
-
-export interface Result {
-  name: string;
-  slug: string; // Optional and has a default value of an empty string
-  value: number; // Deprecated
-  result: string;
-  type: ResultType;
-  unit?: string; // Optional
-  timestamp?: Date; // Optional
-  notes?: string; // Optional
-  min_range_value?: number; // Optional
-  max_range_value?: number; // Optional
-  is_above_max_range?: boolean; // Optional
-  is_below_min_range?: boolean; // Optional
-  interpretation: Interpretation; // default value of Interpretation.NORMAL
-}
-
-export interface AreaInfo {
-  zip_code: string;
-  phlebotomy: PhlebotomyAreaInfo;
-}
-
-export interface PhlebotomyAreaInfo {
-  is_served: boolean;
-}

package/client/models/link_models.ts

@@ -1,41 +0,0 @@
-export type PasswordProviders =
-  | 'whoop'
-  | 'renpho'
-  | 'peloton'
-  | 'zwift'
-  | 'hammerhead'
-  | 'eight_sleep'
-  | 'beurer_api'
-  | 'dexcom'
-  | 'my_fitness_pal';
-
-export type OAuthProviders =
-  | 'oura'
-  | 'fitbit'
-  | 'garmin'
-  | 'strava'
-  | 'wahoo'
-  | 'ihealth'
-  | 'withings'
-  | 'google_fit'
-  | 'dexcom_v3'
-  | 'polar'
-  | 'cronometer';
-
-export type EmailProviders = 'freestyle_libre';
-export type DemoProviders = 'apple_health_kit' | 'fitbit' | 'oura' | 'whoop';
-
-export interface ProviderLinkResponse {
-  provider: PasswordProviders;
-  connected: boolean;
-  provider_id?: string;
-}
-
-export interface LinkTokenExchangeResponse {
-  link_token: string;
-}
-
-export interface DemoConnectionResponse {
-  success: boolean;
-  redirect_url?: string;
-}

package/client/models/meal_model.ts

@@ -1,61 +0,0 @@
-import { SourceClientFacing } from './user_models';
-
-/* tslint:disable */
-/* eslint-disable */
-/**
-/* This file was automatically generated from pydantic models by running pydantic2ts.
-/* Do not modify it by hand - just update the pydantic models and then re-run the script
-*/
-
-export interface MealInDBBaseClientFacingSource {
-    id: string;
-    user_id: string;
-    priority_id: number;
-    source_id: number;
-    provider_id: string;
-    timestamp: string;
-    name: string;
-    energy?: Energy;
-    macros?: Macros;
-    micros?: Micros;
-    source: SourceClientFacing;
-    created_at: string;
-    updated_at: string;
-  }
-  export interface Energy {
-    unit: "kcal";
-    value: number;
-  }
-  export interface Macros {
-    carbs?: number;
-    protein?: number;
-    fats?: Fats;
-    alcohol?: number;
-    water?: number;
-    fibre?: number;
-    sugar?: number;
-  }
-  export interface Fats {
-    saturated?: number;
-    monounsaturated?: number;
-    polyunsaturated?: number;
-    omega3?: number;
-    omega6?: number;
-    total?: number;
-  }
-  export interface Micros {
-    minerals?: {
-      [k: string]: number;
-    };
-    trace_elements?: {
-      [k: string]: number;
-    };
-    vitamins?: {
-      [k: string]: number;
-    };
-  }
-
-  export interface ClientFacingMealResponse {
-    meals: MealInDBBaseClientFacingSource[];
-  }
-  

package/client/models/profile_model.ts

@@ -1,34 +0,0 @@
-import { SourceClientFacing } from './user_models';
-
-export interface ClientFacingProfile {
-  /**
-   * Age of user.::years
-   * @type {number}
-   * @memberof ClientFacingBody
-   */
-  dob?: string;
-  /**
-   * Height in cm.::cm
-   * @type {number}
-   * @memberof ClientFacingBody
-   */
-  height?: number;
-  /**
-   * Gender of user.
-   * @type {string}
-   * @memberof ClientFacingBody
-   */
-  gender?: string;
-  /**
-   * Source the data has come from.
-   * @type {SourceClientFacing}
-   * @memberof ClientFacingBody
-   */
-  source: SourceClientFacing;
-  /**
-   * User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api.
-   * @type {string}
-   * @memberof ClientFacingBody
-   */
-  user_id: string;
-}

package/client/models/provider_models.ts

@@ -1,19 +0,0 @@
-export enum Resource {
-  WORKOUTS = 'workouts',
-  ACTVITY = 'activity',
-  SLEEP = 'sleep',
-  BODY = 'body',
-  WORKOUTS_STREAM = 'workouts/stream',
-  SLEEP_STREAM = 'sleep/stream',
-  HEARTRATE = 'heartrate',
-  GLUCOSE = 'glucose',
-  PROFILE = 'profile',
-}
-
-export interface Provider {
-  name: string;
-  slug: string;
-  logo: string;
-  auth_type: 'password' | 'email' | 'oauth';
-  supported_resources: Resource[];
-}

package/client/models/provider_specific.ts

@@ -1,46 +0,0 @@
-/**
- *
- * @export
- * @interface ClientFacingSourceSpecific
- */
-export interface ClientFacingSourceSpecific {
-  /**
-   *
-   * @type {string}
-   * @memberof ClientFacingSourceSpecific
-   */
-  id: string;
-  /**
-   * Date for specified record
-   * @type {Date}
-   * @memberof ClientFacingSourceSpecific
-   */
-  date: Date;
-  /**
-   * Type of data, activity/sleep/workouts/body
-   * @type {string}
-   * @memberof ClientFacingSourceSpecific
-   */
-  type: 'activity' | 'sleep' | 'body' | 'workouts';
-  /**
-   * JSON data that is specific to the device
-   * @type {any | string}
-   * @memberof ClientFacingSourceSpecific
-   */
-  data: unknown;
-  /**
-   * User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api.
-   * @type {string}
-   * @memberof ClientFacingSourceSpecific
-   */
-  user_id: string;
-}
-
-export interface ClientProviderSpecificResponse {
-  /**
-   *
-   * @type {Array<ClientFacingSourceSpecific>}
-   * @memberof ClientProviderSpecificResponse
-   */
-  provider_specific: ClientFacingSourceSpecific[];
-}

package/client/models/raw_response.ts

@@ -1,44 +0,0 @@
-import { SourceClientFacing } from './user_models';
-
-export interface RawResponse {
-  id: string;
-  user_id: string;
-  source_id: number;
-  source?: SourceClientFacing;
-  priority: number;
-  priority_id: number;
-  timestamp: Date;
-  data: Record<string, string>;
-  provider_id: string;
-}
-
-export interface DeviceRawResponse {
-  id: string;
-  user_id: string;
-  source_id: number;
-  source?: SourceClientFacing;
-  data: Record<string, string>;
-  provider_id: string;
-}
-
-export interface ClientActivityRawResponse {
-  activity: RawResponse[];
-}
-export interface ClientWorkoutsRawResponse {
-  workouts: RawResponse[];
-}
-export interface ClientBodyRawResponse {
-  body: RawResponse[];
-}
-
-export interface ClientSleepRawResponse {
-  sleep: RawResponse[];
-}
-
-export interface ClientProfileRawResponse {
-  profile: RawResponse[];
-}
-
-export interface ClientDevicesRawResponse {
-  devices: DeviceRawResponse[];
-}

package/client/models/sleep_models.ts

@@ -1,171 +0,0 @@
-import { TimeseriesPoint } from './activity';
-import { SourceClientFacing } from './user_models';
-
-/**
- *
- * @export
- * @interface ClientFacingSleep
- */
-export interface ClientFacingSleep {
-  /**
-   *
-   * @type {string}
-   * @memberof ClientFacingSleep
-   */
-  id: string;
-  /**
-   * Date for specified record
-   * @type {Date}
-   * @memberof ClientFacingSleep
-   * @deprecated Use calendar_date instead
-   */
-  date: Date;
-  /**
-   * Date for specified record (YYYY-MM-DD). This generally matches the sleep end date.
-   * @type {String}
-   * @memberof ClientFacingSleep
-   */
-  calendar_date: string;
-  /**
-   * UTC Time when the sleep period started
-   * @type {Date}
-   * @memberof ClientFacingSleep
-   */
-  bedtime_start: Date;
-  /**
-   * UTC Time when the sleep period ended
-   * @type {Date}
-   * @memberof ClientFacingSleep
-   */
-  bedtime_stop: Date;
-  /**
-   * Timezone offset from UTC as minutes. For example, EEST (Eastern European Summer Time, +3h) is 180. PST (Pacific Standard Time, -8h) is -480. Note that timezone information is also available in the datetime values themselves, see for example.bedtime_start.::minutes
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  timezone_offset?: number;
-  /**
-   * Total duration of the sleep period (sleep.duration = sleep.bedtime_end - sleep.bedtime_start).::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  duration: number;
-  /**
-   * Total amount of sleep registered during the sleep period (sleep.total = sleep.rem + sleep.light + sleep.deep).::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  total: number;
-  /**
-   * Total amount of awake time registered during the sleep period.::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  awake: number;
-  /**
-   * Total amount of light sleep registered during the sleep period::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  light: number;
-  /**
-   * Total amount of REM sleep registered during the sleep period, minutes::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  rem: number;
-  /**
-   * Total amount of deep (N3) sleep registered during the sleep period::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  deep: number;
-  /**
-   * The lowest heart rate (5 minutes sliding average) registered during the sleep period.::beats per minute
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  hr_lowest?: number;
-  /**
-   * The average heart rate registered during the sleep period.::beats per minute
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  hr_average?: number;
-  /**
-   * Sleep efficiency is the percentage of the sleep period spent asleep (100% * sleep.total / sleep.duration).::perc
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  efficiency?: number;
-  /**
-   * Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep.::seconds
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  latency?: number;
-  /**
-   * Skin temperature deviation from the long-term temperature average.::celcius
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  temperature_delta?: number;
-  /**
-   * The average heart rate registered during the sleep period.::beats per minute
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  average_hrv?: number;
-  /**
-   * Average respiratory rate.::breaths per minute
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  respiratory_rate?: number;
-  /**
-   * Average skin temperature.::celcius
-   * @type {number}
-   * @memberof ClientFacingSleep
-   */
-  skin_temperature?: number;
-  /**
-   * Source the data has come from.
-   * @type {SourceClientFacing}
-   * @memberof ClientFacingSleep
-   */
-  source: SourceClientFacing;
-  /**
-   * User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api.
-   * @type {string}
-   * @memberof ClientFacingSleep
-   */
-  user_id: string;
-  /**
-   * UTC time when the sleep period started
-   * @type {ClientSleepStreamResponse}
-   * @memberof ClientFacingSleep
-   * 
-   */
-  sleep_stream: ClientSleepStreamResponse;
-}
-
-export interface ClientSleepResponse {
-  /**
-   *
-   * @type {Array<ClientFacingSleep>}
-   * @memberof ClientSleepResponse
-   */
-  sleep: ClientFacingSleep[];
-}
-
-export interface ClientSleepStreamResponse {
-  /**
-   *
-   * @type {Array<ClientFacingSleep>}
-   * @memberof ClientSleepResponse
-   */
-  hrv: TimeseriesPoint[];
-  heartrate: TimeseriesPoint[];
-  respiratory_rate: TimeseriesPoint[];
-  hypnogram: TimeseriesPoint[];
-}