@tryvital/vital-node 1.0.9 → 1.2.0

package/client/Activity.ts

@@ -11,13 +11,13 @@ export class ActivityApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientActivityResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/activity/${userKey}`),
+      this.baseURL.concat(`/summary/activity/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -26,13 +26,13 @@ export class ActivityApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientActivityRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/activity/${userKey}/raw`),
+      this.baseURL.concat(`/summary/activity/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Body.ts

@@ -12,13 +12,13 @@ export class BodyApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientBodyResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/body/${userKey}`),
+      this.baseURL.concat(`/summary/body/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -26,15 +26,14 @@ export class BodyApi {
     return resp.data;
   }
 
-
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientBodyRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/body/${userKey}/raw`),
+      this.baseURL.concat(`/summary/body/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Devices.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from 'axios';
+import { ClientDevicesRawResponse } from './models/raw_response';
+
+export class DevicesAPI {
+  baseURL: string;
+  client: AxiosInstance;
+
+  constructor(baseURL: string, axios: AxiosInstance) {
+    this.baseURL = baseURL;
+    this.client = axios;
+  }
+
+  public async get_raw(
+    userId: string,
+    provider?: string
+  ): Promise<ClientDevicesRawResponse> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/summary/devices/${userId}/raw`),
+      {
+        params: { provider },
+      }
+    );
+    return resp.data;
+  }
+}

package/client/Link.ts

@@ -17,11 +17,11 @@ export class LinkApi {
   }
 
   public async create(
-    userKey: string,
+    userId: string,
     provider: string = null
   ): Promise<LinkTokenExchangeResponse> {
     const resp = await this.client.post(this.baseURL.concat('/link/token/'), {
-      user_key: userKey,
+      user_key: userId,
       provider,
     });
     return resp.data;

package/client/Profile.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { ClientFacingProfile, } from './models/profile_model';
+import { ClientFacingProfile } from './models/profile_model';
 import { ClientProfileRawResponse } from './models/raw_response';
 
 export class ProfileApi {
@@ -12,11 +12,11 @@ export class ProfileApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     provider?: string
   ): Promise<ClientFacingProfile> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/profile/${userKey}`),
+      this.baseURL.concat(`/summary/profile/${userId}`),
       {
         params: { provider },
       }
@@ -25,13 +25,13 @@ export class ProfileApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientProfileRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/profile/${userKey}/raw`),
+      this.baseURL.concat(`/summary/profile/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Provider.ts

@@ -0,0 +1,17 @@
+import { AxiosInstance } from 'axios';
+import { Provider } from './models/provider_models';
+
+export class ProviderApi {
+  baseURL: string;
+  client: AxiosInstance;
+
+  constructor(baseURL: string, axios: AxiosInstance) {
+    this.baseURL = baseURL;
+    this.client = axios;
+  }
+
+  public async getSupportedProviders(): Promise<Provider[]> {
+    const resp = await this.client.get(this.baseURL.concat('/providers/'));
+    return resp.data;
+  }
+}

package/client/Sleep.ts

@@ -1,5 +1,8 @@
 import { AxiosInstance } from 'axios';
-import { ClientSleepResponse, ClientSleepStreamResponse  } from './models/sleep_models';
+import {
+  ClientSleepResponse,
+  ClientSleepStreamResponse,
+} from './models/sleep_models';
 import { ClientSleepRawResponse } from './models/raw_response';
 
 export class SleepApi {
@@ -11,13 +14,13 @@ export class SleepApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientSleepResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/sleep/${userKey}`),
+      this.baseURL.concat(`/summary/sleep/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -33,13 +36,13 @@ export class SleepApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientSleepRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/sleep/${userKey}/raw`),
+      this.baseURL.concat(`/summary/sleep/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Testkits.ts

@@ -1,5 +1,7 @@
 import { AxiosInstance } from 'axios';
 import {
+  LabResultsMetadata,
+  LabResultsRaw,
   Order,
   OrderRequestResponse,
   OrderResponse,
@@ -35,7 +37,7 @@ export class TestkitsApi {
   }
 
   public async order(
-    userKey: string,
+    userId: string,
     testkitId: string,
     patientAddress: PatientAdress,
     patientDetails: PatientDetails
@@ -43,7 +45,7 @@ export class TestkitsApi {
     const resp = await this.client.post(
       this.baseURL.concat('/testkit/orders'),
       {
-        user_key: userKey,
+        user_key: userId,
         testkit_id: testkitId,
         patient_address: patientAddress,
         patient_details: patientDetails,
@@ -68,4 +70,18 @@ export class TestkitsApi {
     );
     return resp.data;
   }
+
+  public async getMetadata(orderId: string): Promise<LabResultsMetadata> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/testkit/orders/${orderId}/results/metadata`)
+    );
+    return resp.data;
+  }
+
+  public async getRawResults(orderId: string): Promise<LabResultsRaw> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/testkit/orders/${orderId}/results/raw`)
+    );
+    return resp.data;
+  }
 }

package/client/User.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import {
-  UserKeyResponse,
+  UserIdResponse,
   SuccessResponse,
   ClientFacingUser,
   Providers,
@@ -15,16 +15,16 @@ export class UserApi {
     this.client = axios;
   }
 
-  public async create(clientUserId: string): Promise<UserKeyResponse> {
+  public async create(clientUserId: string): Promise<UserIdResponse> {
     const resp = await this.client.post(this.baseURL.concat('/user/key'), {
       client_user_id: clientUserId,
     });
     return resp.data;
   }
 
-  public async delete(userKey: string): Promise<SuccessResponse> {
+  public async delete(userId: string): Promise<SuccessResponse> {
     const resp = await this.client.delete(
-      this.baseURL.concat(`/user/${userKey}`)
+      this.baseURL.concat(`/user/${userId}`)
     );
     return resp.data;
   }
@@ -34,8 +34,8 @@ export class UserApi {
     return resp.data;
   }
 
-  public async get(userKey: string): Promise<ClientFacingUser> {
-    const resp = await this.client.get(this.baseURL.concat(`/user/${userKey}`));
+  public async get(userId: string): Promise<ClientFacingUser> {
+    const resp = await this.client.get(this.baseURL.concat(`/user/${userId}`));
     return resp.data;
   }
 
@@ -46,19 +46,28 @@ export class UserApi {
     return resp.data;
   }
 
-  public async providers(userKey: string): Promise<ProvidersResponse> {
+  public async providers(userId: string): Promise<ProvidersResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/user/providers/${userKey}`)
+      this.baseURL.concat(`/user/providers/${userId}`)
     );
     return resp.data;
   }
 
   public async deregisterProvider(
-    userKey: string,
+    userId: string,
     provider: Providers
   ): Promise<SuccessResponse> {
     const resp = await this.client.delete(
-      this.baseURL.concat(`/user/${userKey}/${provider}`)
+      this.baseURL.concat(`/user/${userId}/${provider}`)
+    );
+    return resp.data;
+  }
+
+  public async refresh(
+    userId: string,
+  ): Promise<SuccessResponse> {
+    const resp = await this.client.post(
+      this.baseURL.concat(`/user/refresh/${userId}`)
     );
     return resp.data;
   }

package/client/Vitals.ts

@@ -27,13 +27,13 @@ export class VitalsApi {
 
   public async cholesterol(
     type: 'ldl' | 'total' | 'triglycerides' | 'hdl',
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
-      userKey,
+      userId,
       `cholesterol/${type}`,
       startDate,
       endDate,
@@ -42,13 +42,13 @@ export class VitalsApi {
   }
 
   public async glucose(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
-      userKey,
+      userId,
       'glucose',
       startDate,
       endDate,
@@ -57,31 +57,31 @@ export class VitalsApi {
   }
 
   public async ige(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
-    return this.timeseriesData(userKey, 'ige', startDate, endDate, provider);
+    return this.timeseriesData(userId, 'ige', startDate, endDate, provider);
   }
 
   public async igg(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
-    return this.timeseriesData(userKey, 'igg', startDate, endDate, provider);
+    return this.timeseriesData(userId, 'igg', startDate, endDate, provider);
   }
 
   public async heartrate(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
-      userKey,
+      userId,
       'heartrate',
       startDate,
       endDate,

package/client/Webhooks.ts

@@ -9,7 +9,7 @@ export class WebhooksApi {
     this.client = axios;
   }
 
-  public static constructWebhookEvent(
+  public constructWebhookEvent(
     payload: string,
     headers: Record<string, string>,
     secret: string

package/client/Workouts.ts

@@ -14,13 +14,13 @@ export class WorkoutsApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientWorkoutResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/workouts/${userKey}`),
+      this.baseURL.concat(`/summary/workouts/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -38,13 +38,13 @@ export class WorkoutsApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientWorkoutsRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/workouts/${userKey}/raw`),
+      this.baseURL.concat(`/summary/workouts/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/index.ts

@@ -7,3 +7,4 @@ export { WebhooksApi } from './Webhooks';
 export { WorkoutsApi } from './Workouts';
 export { TestkitsApi } from './Testkits';
 export { ProfileApi } from './Profile';
+export { DevicesAPI } from './Devices';

package/client/models/body_model.ts

@@ -37,7 +37,7 @@ export interface ClientFacingBody {
    */
   source: SourceClientFacing;
   /**
-   * User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
+   * 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
    */

package/client/models/profile_model.ts

@@ -26,7 +26,7 @@ export interface ClientFacingProfile {
    */
   source: SourceClientFacing;
   /**
-   * User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
+   * 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
    */

package/client/models/provider_models.ts

@@ -0,0 +1,19 @@
+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

@@ -29,7 +29,7 @@ export interface ClientFacingSourceSpecific {
    */
   data: unknown;
   /**
-   * User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
+   * 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
    */

package/client/models/raw_response.ts

@@ -8,7 +8,16 @@ export interface RawResponse {
   priority: number;
   priority_id: number;
   timestamp: Date;
-  data: Record<string, string>
+  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;
 }
 
@@ -29,3 +38,7 @@ export interface ClientSleepRawResponse {
 export interface ClientProfileRawResponse {
   profile: RawResponse[];
 }
+
+export interface ClientDevicesRawResponse {
+  devices: DeviceRawResponse[];
+}

package/client/models/sleep_models.ts

@@ -122,7 +122,7 @@ export interface ClientFacingSleep {
    */
   source: SourceClientFacing;
   /**
-   * User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
+   * 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
    */

package/client/models/testkit_models.ts

@@ -68,3 +68,22 @@ export interface OrderRequestResponse {
 export interface TestkitResponse {
   testkits: Testkit[];
 }
+
+export interface LabResultsMetadata {
+  age: string;
+  dob: string;
+  clia_number: string;
+  patient: string;
+  provider: string;
+  laboratory: string;
+  date_reported: string;
+  date_collected: string;
+  specimen_number: string;
+  date_received?: string;
+  clia?: string;
+}
+
+export interface LabResultsRaw {
+  metadata: LabResultsMetadata;
+  data: Record<string, string>;
+}

package/client/models/user_models.ts

@@ -1,6 +1,6 @@
-export interface UserKeyResponse {
+export interface UserIdResponse {
   client_user_id: string;
-  user_key: string;
+  user_id: string;
 }
 
 export interface SuccessResponse {

package/client/models/workout_models.ts

@@ -82,7 +82,7 @@ export interface ClientFacingWorkout {
    */
   hr_zones: number[];
   /**
-   * User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
+   * 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 ClientFacingWorkout
    */

package/dist/client/Activity.d.ts

@@ -5,6 +5,6 @@ export declare class ActivityApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    get(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientActivityResponse>;
-    get_raw(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientActivityRawResponse>;
+    get(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientActivityResponse>;
+    get_raw(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientActivityRawResponse>;
 }

package/dist/client/Activity.js

@@ -42,12 +42,12 @@ var ActivityApi = /** @class */ (function () {
         this.baseURL = baseURL;
         this.client = axios;
     }
-    ActivityApi.prototype.get = function (userKey, startDate, endDate, provider) {
+    ActivityApi.prototype.get = function (userId, startDate, endDate, provider) {
         return __awaiter(this, void 0, void 0, function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/activity/" + userKey), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/activity/" + userId), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:
@@ -57,12 +57,12 @@ var ActivityApi = /** @class */ (function () {
             });
         });
     };
-    ActivityApi.prototype.get_raw = function (userKey, startDate, endDate, provider) {
+    ActivityApi.prototype.get_raw = function (userId, startDate, endDate, provider) {
         return __awaiter(this, void 0, void 0, function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/activity/" + userKey + "/raw"), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/activity/" + userId + "/raw"), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:

package/dist/client/Body.d.ts

@@ -5,6 +5,6 @@ export declare class BodyApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    get(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientBodyResponse>;
-    get_raw(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientBodyRawResponse>;
+    get(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientBodyResponse>;
+    get_raw(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientBodyRawResponse>;
 }

package/dist/client/Body.js

@@ -42,12 +42,12 @@ var BodyApi = /** @class */ (function () {
         this.baseURL = baseURL;
         this.client = axios;
     }
-    BodyApi.prototype.get = function (userKey, startDate, endDate, provider) {
+    BodyApi.prototype.get = function (userId, startDate, endDate, provider) {
         return __awaiter(this, void 0, void 0, function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/body/" + userKey), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/body/" + userId), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:
@@ -57,12 +57,12 @@ var BodyApi = /** @class */ (function () {
             });
         });
     };
-    BodyApi.prototype.get_raw = function (userKey, startDate, endDate, provider) {
+    BodyApi.prototype.get_raw = function (userId, startDate, endDate, provider) {
         return __awaiter(this, void 0, void 0, function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/body/" + userKey + "/raw"), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/body/" + userId + "/raw"), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:

package/dist/client/Devices.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from 'axios';
+import { ClientDevicesRawResponse } from './models/raw_response';
+export declare class DevicesAPI {
+    baseURL: string;
+    client: AxiosInstance;
+    constructor(baseURL: string, axios: AxiosInstance);
+    get_raw(userId: string, provider?: string): Promise<ClientDevicesRawResponse>;
+}