@tryvital/vital-node 0.3.9 → 1.0.3

package/client/Activity.ts

@@ -16,7 +16,7 @@ export class ActivityApi {
     provider?: string
   ): Promise<ClientActivityResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/activity/${userKey}`),
+      this.baseURL.concat(`/summary/activity/${userKey}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Body.ts

@@ -17,7 +17,7 @@ export class BodyApi {
     provider?: string
   ): Promise<ClientBodyResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/body/${userKey}`),
+      this.baseURL.concat(`/summary/body/${userKey}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Profile.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from 'axios';
+import { ClientFacingProfile } from './models/profile_model';
+
+export class ProfileApi {
+  baseURL: string;
+  client: AxiosInstance;
+
+  constructor(baseURL: string, axios: AxiosInstance) {
+    this.baseURL = baseURL;
+    this.client = axios;
+  }
+
+  public async get(
+    userKey: string,
+    provider?: string
+  ): Promise<ClientFacingProfile> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/summary/profile/${userKey}`),
+      {
+        params: { provider },
+      }
+    );
+    return resp.data;
+  }
+}

package/client/Sleep.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { ClientSleepResponse } from './models/sleep_models';
+import { ClientSleepResponse, ClientSleepStreamResponse } from './models/sleep_models';
 
 export class SleepApi {
   baseURL: string;
@@ -16,7 +16,7 @@ export class SleepApi {
     provider?: string
   ): Promise<ClientSleepResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/sleep/${userKey}`),
+      this.baseURL.concat(`/summary/sleep/${userKey}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -24,9 +24,9 @@ export class SleepApi {
     return resp.data;
   }
 
-  public async getStream(sleepId: string): Promise<ClientSleepResponse> {
+  public async getStream(sleepId: string): Promise<ClientSleepStreamResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/sleep/${sleepId}/stream/data`)
+      this.baseURL.concat(`/timeseries/sleep/${sleepId}/stream`)
     );
     return resp.data;
   }

package/client/Testkits.ts

@@ -1,5 +1,4 @@
 import { AxiosInstance } from 'axios';
-import { signature } from './lib/WebhookVerification';
 import {
   Order,
   OrderRequestResponse,
@@ -59,4 +58,14 @@ export class TestkitsApi {
     );
     return resp.data;
   }
+
+  public async get_results(orderId: string): Promise<string> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/testkit/orders/${orderId}/results`),
+      {
+        responseType: 'arraybuffer',
+      }
+    );
+    return resp.data;
+  }
 }

package/client/Vitals.ts

@@ -1,11 +1,5 @@
 import { AxiosInstance } from 'axios';
-import {
-  ClientCholesterolResponse,
-  ClientGlucoseResponse,
-  ClientHba1cResponse,
-  ClientIgeResponse,
-  ClientIggResponse,
-} from './models/activity';
+import { TimeseriesPoint } from './models/activity';
 
 export class VitalsApi {
   baseURL: string;
@@ -15,15 +9,15 @@ export class VitalsApi {
     this.client = axios;
   }
 
-  public async cholesterol(
-    type: 'ldl' | 'total_cholesterol' | 'triglycerides' | 'hdl',
-    userKey: string,
+  private async timeseriesData(
+    user_key: string,
+    resource: string,
     startDate: Date,
     endDate: Date,
     provider?: string
-  ): Promise<ClientCholesterolResponse> {
+  ): Promise<TimeseriesPoint[]> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/vitals/cholesterol/${type}/${userKey}`),
+      this.baseURL.concat(`/timeseries/${user_key}/${resource}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -31,61 +25,67 @@ export class VitalsApi {
     return resp.data;
   }
 
-  public async glucose(
+  public async cholesterol(
+    type: 'ldl' | 'total' | 'triglycerides' | 'hdl',
     userKey: string,
     startDate: Date,
     endDate: Date,
     provider?: string
-  ): Promise<ClientGlucoseResponse> {
-    const resp = await this.client.get(
-      this.baseURL.concat(`/vitals/glucose/${userKey}`),
-      {
-        params: { start_date: startDate, end_date: endDate, provider },
-      }
+  ): Promise<TimeseriesPoint[]> {
+    return this.timeseriesData(
+      userKey,
+      `cholesterol/${type}`,
+      startDate,
+      endDate,
+      provider
     );
-    return resp.data;
   }
 
-  public async hba1c(
+  public async glucose(
     userKey: string,
     startDate: Date,
     endDate: Date,
     provider?: string
-  ): Promise<ClientHba1cResponse> {
-    const resp = await this.client.get(
-      this.baseURL.concat(`/vitals/hba1c/${userKey}`),
-      {
-        params: { start_date: startDate, end_date: endDate, provider },
-      }
+  ): Promise<TimeseriesPoint[]> {
+    return this.timeseriesData(
+      userKey,
+      'glucose',
+      startDate,
+      endDate,
+      provider
     );
-    return resp.data;
   }
 
   public async ige(
     userKey: string,
     startDate: Date,
-    endDate: Date
-  ): Promise<ClientIgeResponse> {
-    const resp = await this.client.get(
-      this.baseURL.concat(`/vitals/ige/${userKey}`),
-      {
-        params: { start_date: startDate, end_date: endDate },
-      }
-    );
-    return resp.data;
+    endDate: Date,
+    provider?: string
+  ): Promise<TimeseriesPoint[]> {
+    return this.timeseriesData(userKey, 'ige', startDate, endDate, provider);
   }
 
   public async igg(
     userKey: string,
     startDate: Date,
-    endDate: Date
-  ): Promise<ClientIggResponse> {
-    const resp = await this.client.get(
-      this.baseURL.concat(`/vitals/igg/${userKey}`),
-      {
-        params: { start_date: startDate, end_date: endDate },
-      }
+    endDate: Date,
+    provider?: string
+  ): Promise<TimeseriesPoint[]> {
+    return this.timeseriesData(userKey, 'igg', startDate, endDate, provider);
+  }
+
+  public async heartrate(
+    userKey: string,
+    startDate: Date,
+    endDate: Date,
+    provider?: string
+  ): Promise<TimeseriesPoint[]> {
+    return this.timeseriesData(
+      userKey,
+      'heartrate',
+      startDate,
+      endDate,
+      provider
     );
-    return resp.data;
   }
 }

package/client/Webhooks.ts

@@ -1,71 +1,20 @@
 import { AxiosInstance } from 'axios';
-import { signature } from './lib/WebhookVerification';
-import {
-  ClientWebhookResponse,
-  WebhookEventTypes,
-  ClientFacingWebhook,
-} from './models/webhook_models';
+import { Webhook } from 'svix';
 
 export class WebhooksApi {
-  DEFAULT_TOLERANCE: number;
-
   baseURL: string;
   client: AxiosInstance;
   constructor(baseURL: string, axios: AxiosInstance) {
     this.baseURL = baseURL;
     this.client = axios;
-    this.DEFAULT_TOLERANCE = 300; // 5 minutes
-  }
-
-  public async getAll(): Promise<ClientWebhookResponse> {
-    const resp = await this.client.get(this.baseURL.concat('/webhooks/'));
-    return resp.data;
-  }
-
-  public async register(
-    callbackUrl: string,
-    verifyToken: string,
-    eventType: WebhookEventTypes
-  ): Promise<ClientFacingWebhook> {
-    const resp = await this.client.post(this.baseURL.concat('/webhooks/'), {
-      callback_url: callbackUrl,
-      verify_token: verifyToken,
-      event_type: eventType,
-    });
-    return resp.data;
-  }
-
-  public async deregister(webhookId: string): Promise<ClientFacingWebhook> {
-    const resp = await this.client.delete(
-      this.baseURL.concat(`/webhooks/${webhookId}`)
-    );
-    return resp.data;
-  }
-
-  public async test(
-    event_code: 'HISTORICAL_DATA_UPDATE' | 'CREATED',
-    webhook_type: 'activity' | 'body' | 'sleep' | 'workouts'
-  ): Promise<ClientFacingWebhook> {
-    const resp = await this.client.post(this.baseURL.concat('/webhooks/test'), {
-      event_code,
-      webhook_type,
-    });
-    return resp.data;
   }
 
-  public constructWebhookEvent(
+  public static constructWebhookEvent(
     payload: string,
-    header: string,
-    secret: string,
-    tolerance: number = undefined
-  ): Record<string, unknown> {
-    signature.verifyHeader(
-      payload,
-      header,
-      secret,
-      tolerance || this.DEFAULT_TOLERANCE
-    );
-    const jsonPayload = JSON.parse(payload);
-    return jsonPayload;
+    headers: Record<string, string>,
+    secret: string
+  ): unknown {
+    const wh = new Webhook(secret);
+    return wh.verify(payload, headers);
   }
 }

package/client/Workouts.ts

@@ -19,7 +19,7 @@ export class WorkoutsApi {
     provider?: string
   ): Promise<ClientWorkoutResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/workouts/${userKey}`),
+      this.baseURL.concat(`/summary/workouts/${userKey}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -27,11 +27,11 @@ export class WorkoutsApi {
     return resp.data;
   }
 
-  public async get_stream(
+  public async getStream(
     workoutId: string
   ): Promise<ClientWorkoutStreamResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/workouts/${workoutId}/stream/data`)
+      this.baseURL.concat(`/timeseries/workouts/${workoutId}/stream`)
     );
     return resp.data;
   }

package/client/index.ts

@@ -1,9 +1,9 @@
 export { ActivityApi } from './Activity';
 export { BodyApi } from './Body';
 export { LinkApi } from './Link';
-export { ProviderSpecificApi } from './ProviderSpecific';
 export { SleepApi } from './Sleep';
 export { UserApi } from './User';
 export { WebhooksApi } from './Webhooks';
 export { WorkoutsApi } from './Workouts';
 export { TestkitsApi } from './Testkits';
+export { ProfileApi } from './Profile';

package/client/models/activity.ts

@@ -94,6 +94,13 @@ export interface ClientCholesterolResponse {
   cholesterol: ClientFacingCholesterol[];
 }
 
+export interface TimeseriesPoint {
+  timestamp: Date;
+  value: number;
+  type: string;
+  unit: string;
+}
+
 enum RespiratoryAllergen {
   D_PTERONYSSINUS = 'd_pteronyssinus',
   D_FARINAE = 'd_farinae',

package/client/models/body_model.ts

@@ -30,24 +30,6 @@ export interface ClientFacingBody {
    * @memberof ClientFacingBody
    */
   fat?: number;
-  /**
-   * Age of user.::years
-   * @type {number}
-   * @memberof ClientFacingBody
-   */
-  age?: number;
-  /**
-   * 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}

package/client/models/profile_model.ts

@@ -0,0 +1,34 @@
+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 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.
+   * @type {string}
+   * @memberof ClientFacingBody
+   */
+  user_id: string;
+}

package/client/models/sleep_models.ts

@@ -1,3 +1,4 @@
+import { TimeseriesPoint } from './activity';
 import { SourceClientFacing } from './user_models';
 
 /**
@@ -136,3 +137,15 @@ export interface ClientSleepResponse {
    */
   sleep: ClientFacingSleep[];
 }
+
+export interface ClientSleepStreamResponse {
+  /**
+   *
+   * @type {Array<ClientFacingSleep>}
+   * @memberof ClientSleepResponse
+   */
+  hrv: TimeseriesPoint[];
+  heartrate: TimeseriesPoint[];
+  respiratory_rate: TimeseriesPoint[];
+  hypnogram: TimeseriesPoint[];
+}

package/dist/client/Activity.js

@@ -47,7 +47,7 @@ var ActivityApi = /** @class */ (function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/activity/" + userKey), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/activity/" + userKey), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:

package/dist/client/Body.js

@@ -47,7 +47,7 @@ var BodyApi = /** @class */ (function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/body/" + userKey), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/body/" + userKey), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:

package/dist/client/Profile.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from 'axios';
+import { ClientFacingProfile } from './models/profile_model';
+export declare class ProfileApi {
+    baseURL: string;
+    client: AxiosInstance;
+    constructor(baseURL: string, axios: AxiosInstance);
+    get(userKey: string, provider?: string): Promise<ClientFacingProfile>;
+}

package/dist/client/{ProviderSpecific.js → Profile.js}

@@ -36,23 +36,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProviderSpecificApi = void 0;
-var ProviderSpecificApi = /** @class */ (function () {
-    function ProviderSpecificApi(baseURL, axios) {
+exports.ProfileApi = void 0;
+var ProfileApi = /** @class */ (function () {
+    function ProfileApi(baseURL, axios) {
         this.baseURL = baseURL;
         this.client = axios;
     }
-    ProviderSpecificApi.prototype.get = function (userKey, startDate, endDate, provider, dataType) {
+    ProfileApi.prototype.get = function (userKey, 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("/provider-specific/" + userKey + "/" + provider), {
-                            params: {
-                                start_date: startDate,
-                                end_date: endDate,
-                                data_type: dataType,
-                            },
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/profile/" + userKey), {
+                            params: { provider: provider },
                         })];
                     case 1:
                         resp = _a.sent();
@@ -61,6 +57,6 @@ var ProviderSpecificApi = /** @class */ (function () {
             });
         });
     };
-    return ProviderSpecificApi;
+    return ProfileApi;
 }());
-exports.ProviderSpecificApi = ProviderSpecificApi;
+exports.ProfileApi = ProfileApi;

package/dist/client/Sleep.d.ts

@@ -1,9 +1,9 @@
 import { AxiosInstance } from 'axios';
-import { ClientSleepResponse } from './models/sleep_models';
+import { ClientSleepResponse, ClientSleepStreamResponse } from './models/sleep_models';
 export declare class SleepApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
     get(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientSleepResponse>;
-    getStream(sleepId: string): Promise<ClientSleepResponse>;
+    getStream(sleepId: string): Promise<ClientSleepStreamResponse>;
 }

package/dist/client/Sleep.js

@@ -47,7 +47,7 @@ var SleepApi = /** @class */ (function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/sleep/" + userKey), {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/sleep/" + userKey), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:
@@ -62,7 +62,7 @@ var SleepApi = /** @class */ (function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/sleep/" + sleepId + "/stream/data"))];
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/timeseries/sleep/" + sleepId + "/stream"))];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];

package/dist/client/Testkits.d.ts

@@ -8,4 +8,5 @@ export declare class TestkitsApi {
     get_orders(startDate: Date, endDate: Date): Promise<OrderResponse>;
     order(userKey: string, testkitId: string, patientAddress: PatientAdress, patientDetails: PatientDetails): Promise<OrderRequestResponse>;
     get_order(orderId: string): Promise<Order>;
+    get_results(orderId: string): Promise<string>;
 }

package/dist/client/Testkits.js

@@ -101,6 +101,21 @@ var TestkitsApi = /** @class */ (function () {
             });
         });
     };
+    TestkitsApi.prototype.get_results = function (orderId) {
+        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("/testkit/orders/" + orderId + "/results"), {
+                            responseType: 'arraybuffer',
+                        })];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                }
+            });
+        });
+    };
     return TestkitsApi;
 }());
 exports.TestkitsApi = TestkitsApi;

package/dist/client/Vitals.d.ts

@@ -1,12 +1,13 @@
 import { AxiosInstance } from 'axios';
-import { ClientCholesterolResponse, ClientGlucoseResponse, ClientHba1cResponse, ClientIgeResponse, ClientIggResponse } from './models/activity';
+import { TimeseriesPoint } from './models/activity';
 export declare class VitalsApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    cholesterol(type: 'ldl' | 'total_cholesterol' | 'triglycerides' | 'hdl', userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientCholesterolResponse>;
-    glucose(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientGlucoseResponse>;
-    hba1c(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientHba1cResponse>;
-    ige(userKey: string, startDate: Date, endDate: Date): Promise<ClientIgeResponse>;
-    igg(userKey: string, startDate: Date, endDate: Date): Promise<ClientIggResponse>;
+    private timeseriesData;
+    cholesterol(type: 'ldl' | 'total' | 'triglycerides' | 'hdl', userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    glucose(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    ige(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    igg(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    heartrate(userKey: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
 }