@tryvital/vital-node 1.3.1 → 1.3.2

package/__tests__/sleep.test.ts

@@ -14,4 +14,18 @@ describe('Sleep', () => {
         )
         expect(data.sleep.length).toBeGreaterThan(0)
     });
+
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return sleep data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Sleep.getSleepWithStream(
+            userId,
+            new Date("2021-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.sleep.length).toBeGreaterThan(0)
+        expect(data.sleep[0].sleep_stream).toBeDefined()
+    });
 })

package/client/Sleep.ts

@@ -29,6 +29,21 @@ export class SleepApi {
     return resp.data;
   }
 
+  public async getSleepWithStream(
+    userId: string,
+    startDate: Date,
+    endDate?: Date,
+    provider?: string
+  ): Promise<ClientSleepResponse> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/summary/sleep/${userId}/stream`),
+      {
+        params: { start_date: startDate, end_date: endDate, provider },
+      }
+    );
+    return resp.data;
+  }
+
   public async getStream(sleepId: string): Promise<ClientSleepStreamResponse> {
     const resp = await this.client.get(
       this.baseURL.concat(`/timeseries/sleep/${sleepId}/stream`)

package/client/models/sleep_models.ts

@@ -127,6 +127,13 @@ export interface ClientFacingSleep {
    * @memberof ClientFacingSleep
    */
   user_id: string;
+  /**
+   * UTC time when the sleep period started
+   * @type {ClientSleepStreamResponse}
+   * @memberof ClientFacingSleep
+   * 
+   */
+  sleep_stream: ClientSleepStreamResponse[];
 }
 
 export interface ClientSleepResponse {

package/dist/client/Sleep.d.ts

@@ -6,6 +6,7 @@ export declare class SleepApi {
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
     get(userId: string, startDate: Date, endDate?: Date, provider?: string, with_stream?: boolean): Promise<ClientSleepResponse>;
+    getSleepWithStream(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientSleepResponse>;
     getStream(sleepId: string): Promise<ClientSleepStreamResponse>;
     get_raw(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientSleepRawResponse>;
 }

package/dist/client/Sleep.js

@@ -58,6 +58,21 @@ var SleepApi = /** @class */ (function () {
             });
         });
     };
+    SleepApi.prototype.getSleepWithStream = 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/sleep/" + userId + "/stream"), {
+                            params: { start_date: startDate, end_date: endDate, provider: provider },
+                        })];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                }
+            });
+        });
+    };
     SleepApi.prototype.getStream = function (sleepId) {
         return __awaiter(this, void 0, void 0, function () {
             var resp;

package/dist/client/models/sleep_models.d.ts

@@ -126,6 +126,13 @@ export interface ClientFacingSleep {
      * @memberof ClientFacingSleep
      */
     user_id: string;
+    /**
+     * UTC time when the sleep period started
+     * @type {ClientSleepStreamResponse}
+     * @memberof ClientFacingSleep
+     *
+     */
+    sleep_stream: ClientSleepStreamResponse[];
 }
 export interface ClientSleepResponse {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryvital/vital-node",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Node client for Vital",
   "author": "maitham",
   "keywords": [