@tryvital/vital-node 3.1.426 → 3.1.428

package/reference.md

@@ -7106,10 +7106,25 @@ await client.user.getTeamMetrics();
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getUserSignInToken</a>(userId) -> Vital.UserSignInTokenResponse</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getConnectedProviders</a>(userId) -> Record<string, Vital.ClientFacingProviderWithStatus[]></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+GET Users connected providers
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -7119,7 +7134,7 @@ await client.user.getTeamMetrics();
 <dd>
 
 ```typescript
-await client.user.getUserSignInToken("user_id");
+await client.user.getConnectedProviders("user_id");
 ```
 
 </dd>
@@ -7154,25 +7169,10 @@ await client.user.getUserSignInToken("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getConnectedProviders</a>(userId) -> Record<string, Vital.ClientFacingProviderWithStatus[]></code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestUserInfo</a>(userId) -> Vital.UserInfo</code></summary>
 <dl>
 <dd>
 
-GET Users connected providers
-
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -7182,7 +7182,7 @@ GET Users connected providers
 <dd>
 
 ```typescript
-await client.user.getConnectedProviders("user_id");
+await client.user.getLatestUserInfo("user_id");
 ```
 
 </dd>
@@ -7217,11 +7217,11 @@ await client.user.getConnectedProviders("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Vital.ClientFacingUser</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createInsurance</a>(userId, { ...params }) -> Vital.ClientFacingInsurance</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
 
 <dl>
 <dd>
@@ -7229,14 +7229,35 @@ await client.user.getConnectedProviders("user_id");
 <dl>
 <dd>
 
-GET User details given the user_id.
+```typescript
+await client.user.createInsurance("user_id", {
+    payorCode: "payor_code",
+    memberId: "member_id",
+    relationship: "Self",
+    insured: {
+        firstName: "first_name",
+        lastName: "last_name",
+        gender: "female",
+        address: {
+            firstLine: "first_line",
+            country: "country",
+            zip: "zip",
+            city: "city",
+            state: "state",
+        },
+        dob: "dob",
+        email: "email",
+        phoneNumber: "phone_number",
+    },
+});
+```
 
 </dd>
 </dl>
 </dd>
 </dl>
 
-#### 🔌 Usage
+#### ⚙️ Parameters
 
 <dl>
 <dd>
@@ -7244,24 +7265,15 @@ GET User details given the user_id.
 <dl>
 <dd>
 
-```typescript
-await client.user.get("user_id");
-```
+**userId:** `string`
 
-</dd>
-</dl>
 </dd>
 </dl>
 
-#### ⚙️ Parameters
-
 <dl>
 <dd>
 
-<dl>
-<dd>
-
-**userId:** `string`
+**request:** `Vital.CreateInsuranceRequest`
 
 </dd>
 </dl>
@@ -7280,7 +7292,7 @@ await client.user.get("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Vital.UserSuccessResponse</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestInsurance</a>(userId) -> Vital.ClientFacingInsurance</code></summary>
 <dl>
 <dd>
 
@@ -7293,7 +7305,7 @@ await client.user.get("user_id");
 <dd>
 
 ```typescript
-await client.user.delete("user_id");
+await client.user.getLatestInsurance("user_id");
 ```
 
 </dd>
@@ -7328,7 +7340,7 @@ await client.user.delete("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">patch</a>(userId, { ...params }) -> void</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">upsertUserInfo</a>(userId, { ...params }) -> Vital.UserInfo</code></summary>
 <dl>
 <dd>
 
@@ -7341,7 +7353,21 @@ await client.user.delete("user_id");
 <dd>
 
 ```typescript
-await client.user.patch("user_id");
+await client.user.upsertUserInfo("user_id", {
+    firstName: "first_name",
+    lastName: "last_name",
+    email: "email",
+    phoneNumber: "phone_number",
+    gender: "gender",
+    dob: "dob",
+    address: {
+        firstLine: "first_line",
+        country: "country",
+        zip: "zip",
+        city: "city",
+        state: "state",
+    },
+});
 ```
 
 </dd>
@@ -7365,7 +7391,7 @@ await client.user.patch("user_id");
 <dl>
 <dd>
 
-**request:** `Vital.UserPatchBody`
+**request:** `Vital.UserInfoCreateRequest`
 
 </dd>
 </dl>
@@ -7384,10 +7410,25 @@ await client.user.patch("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestUserInfo</a>(userId) -> Vital.UserInfo</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getByClientUserId</a>(clientUserId) -> Vital.ClientFacingUser</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+GET user_id from client_user_id.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -7397,7 +7438,7 @@ await client.user.patch("user_id");
 <dd>
 
 ```typescript
-await client.user.getLatestUserInfo("user_id");
+await client.user.getByClientUserId("client_user_id");
 ```
 
 </dd>
@@ -7413,7 +7454,7 @@ await client.user.getLatestUserInfo("user_id");
 <dl>
 <dd>
 
-**userId:** `string`
+**clientUserId:** `string` — A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
 
 </dd>
 </dl>
@@ -7432,7 +7473,7 @@ await client.user.getLatestUserInfo("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createInsurance</a>(userId, { ...params }) -> Vital.ClientFacingInsurance</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deregisterProvider</a>(userId, provider) -> Vital.UserSuccessResponse</code></summary>
 <dl>
 <dd>
 
@@ -7445,26 +7486,7 @@ await client.user.getLatestUserInfo("user_id");
 <dd>
 
 ```typescript
-await client.user.createInsurance("user_id", {
-    payorCode: "payor_code",
-    memberId: "member_id",
-    relationship: "Self",
-    insured: {
-        firstName: "first_name",
-        lastName: "last_name",
-        gender: "female",
-        address: {
-            firstLine: "first_line",
-            country: "country",
-            zip: "zip",
-            city: "city",
-            state: "state",
-        },
-        dob: "dob",
-        email: "email",
-        phoneNumber: "phone_number",
-    },
-});
+await client.user.deregisterProvider("user_id", "oura");
 ```
 
 </dd>
@@ -7488,7 +7510,7 @@ await client.user.createInsurance("user_id", {
 <dl>
 <dd>
 
-**request:** `Vital.CreateInsuranceRequest`
+**provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
 
 </dd>
 </dl>
@@ -7507,7 +7529,7 @@ await client.user.createInsurance("user_id", {
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getLatestInsurance</a>(userId) -> Vital.ClientFacingInsurance</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Vital.ClientFacingUser</code></summary>
 <dl>
 <dd>
 
@@ -7520,7 +7542,7 @@ await client.user.createInsurance("user_id", {
 <dd>
 
 ```typescript
-await client.user.getLatestInsurance("user_id");
+await client.user.get("user_id");
 ```
 
 </dd>
@@ -7555,7 +7577,7 @@ await client.user.getLatestInsurance("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">upsertUserInfo</a>(userId, { ...params }) -> Vital.UserInfo</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Vital.UserSuccessResponse</code></summary>
 <dl>
 <dd>
 
@@ -7568,21 +7590,7 @@ await client.user.getLatestInsurance("user_id");
 <dd>
 
 ```typescript
-await client.user.upsertUserInfo("user_id", {
-    firstName: "first_name",
-    lastName: "last_name",
-    email: "email",
-    phoneNumber: "phone_number",
-    gender: "gender",
-    dob: "dob",
-    address: {
-        firstLine: "first_line",
-        country: "country",
-        zip: "zip",
-        city: "city",
-        state: "state",
-    },
-});
+await client.user.delete("user_id");
 ```
 
 </dd>
@@ -7606,44 +7614,77 @@ await client.user.upsertUserInfo("user_id", {
 <dl>
 <dd>
 
-**request:** `Vital.UserInfoCreateRequest`
+**requestOptions:** `User.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
 
 </dd>
 </dl>
+</details>
 
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">patch</a>(userId, { ...params }) -> void</code></summary>
 <dl>
 <dd>
 
-**requestOptions:** `User.RequestOptions`
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.user.patch("user_id");
+```
 
 </dd>
 </dl>
 </dd>
 </dl>
 
-</dd>
-</dl>
-</details>
+#### ⚙️ Parameters
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getByClientUserId</a>(clientUserId) -> Vital.ClientFacingUser</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+<dl>
+<dd>
+
+**userId:** `string`
+
+</dd>
+</dl>
 
 <dl>
 <dd>
 
+**request:** `Vital.UserPatchBody`
+
+</dd>
+</dl>
+
 <dl>
 <dd>
 
-GET user_id from client_user_id.
+**requestOptions:** `User.RequestOptions`
 
 </dd>
 </dl>
 </dd>
 </dl>
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
+<dl>
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -7653,7 +7694,7 @@ GET user_id from client_user_id.
 <dd>
 
 ```typescript
-await client.user.getByClientUserId("client_user_id");
+await client.user.undoDelete();
 ```
 
 </dd>
@@ -7669,7 +7710,7 @@ await client.user.getByClientUserId("client_user_id");
 <dl>
 <dd>
 
-**clientUserId:** `string` — A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
+**request:** `Vital.UserUndoDeleteRequest`
 
 </dd>
 </dl>
@@ -7688,10 +7729,25 @@ await client.user.getByClientUserId("client_user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deregisterProvider</a>(userId, provider) -> Vital.UserSuccessResponse</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Trigger a manual refresh for a specific user
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -7701,7 +7757,7 @@ await client.user.getByClientUserId("client_user_id");
 <dd>
 
 ```typescript
-await client.user.deregisterProvider("user_id", "oura");
+await client.user.refresh("user_id");
 ```
 
 </dd>
@@ -7725,7 +7781,7 @@ await client.user.deregisterProvider("user_id", "oura");
 <dl>
 <dd>
 
-**provider:** `Vital.Providers` — Provider slug. e.g., `oura`, `fitbit`, `garmin`.
+**request:** `Vital.UserRefreshRequest`
 
 </dd>
 </dl>
@@ -7744,7 +7800,7 @@ await client.user.deregisterProvider("user_id", "oura");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">undoDelete</a>({ ...params }) -> Vital.UserSuccessResponse</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevices</a>(userId) -> Vital.ClientFacingDevice[]</code></summary>
 <dl>
 <dd>
 
@@ -7757,7 +7813,7 @@ await client.user.deregisterProvider("user_id", "oura");
 <dd>
 
 ```typescript
-await client.user.undoDelete();
+await client.user.getDevices("user_id");
 ```
 
 </dd>
@@ -7773,7 +7829,7 @@ await client.user.undoDelete();
 <dl>
 <dd>
 
-**request:** `Vital.UserUndoDeleteRequest`
+**userId:** `string`
 
 </dd>
 </dl>
@@ -7792,25 +7848,10 @@ await client.user.undoDelete();
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">refresh</a>(userId, { ...params }) -> Vital.UserRefreshSuccessResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevice</a>(userId, deviceId) -> Vital.ClientFacingDevice</code></summary>
 <dl>
 <dd>
 
-Trigger a manual refresh for a specific user
-
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -7820,7 +7861,7 @@ Trigger a manual refresh for a specific user
 <dd>
 
 ```typescript
-await client.user.refresh("user_id");
+await client.user.getDevice("user_id", "device_id");
 ```
 
 </dd>
@@ -7844,7 +7885,7 @@ await client.user.refresh("user_id");
 <dl>
 <dd>
 
-**request:** `Vital.UserRefreshRequest`
+**deviceId:** `string`
 
 </dd>
 </dl>
@@ -7863,7 +7904,7 @@ await client.user.refresh("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevices</a>(userId) -> Vital.ClientFacingDevice[]</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getUserSignInToken</a>(userId) -> Vital.UserSignInTokenResponse</code></summary>
 <dl>
 <dd>
 
@@ -7876,7 +7917,7 @@ await client.user.refresh("user_id");
 <dd>
 
 ```typescript
-await client.user.getDevices("user_id");
+await client.user.getUserSignInToken("user_id");
 ```
 
 </dd>
@@ -7911,7 +7952,7 @@ await client.user.getDevices("user_id");
 </dl>
 </details>
 
-<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getDevice</a>(userId, deviceId) -> Vital.ClientFacingDevice</code></summary>
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">createPortalUrl</a>(userId, { ...params }) -> Vital.CreateUserPortalUrlResponse</code></summary>
 <dl>
 <dd>
 
@@ -7924,7 +7965,9 @@ await client.user.getDevices("user_id");
 <dd>
 
 ```typescript
-await client.user.getDevice("user_id", "device_id");
+await client.user.createPortalUrl("user_id", {
+    context: "launch",
+});
 ```
 
 </dd>
@@ -7948,7 +7991,7 @@ await client.user.getDevice("user_id", "device_id");
 <dl>
 <dd>
 
-**deviceId:** `string`
+**request:** `Vital.CreateUserPortalUrlBody`
 
 </dd>
 </dl>

package/serialization/resources/index.d.ts

@@ -1,11 +1,12 @@
 export * as link from "./link";
 export * from "./link/types";
+export * as user from "./user";
+export * from "./user/types";
 export * as labTests from "./labTests";
 export * from "./labTests/types";
 export * as aggregate from "./aggregate";
 export * from "./aggregate/types";
 export * as vitals from "./vitals";
-export * as user from "./user";
 export * as team from "./team";
 export * as providers from "./providers";
 export * as insurance from "./insurance";

package/serialization/resources/index.js

@@ -26,15 +26,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.payor = exports.order = exports.testkit = exports.insurance = exports.providers = exports.team = exports.user = exports.vitals = exports.aggregate = exports.labTests = exports.link = void 0;
+exports.payor = exports.order = exports.testkit = exports.insurance = exports.providers = exports.team = exports.vitals = exports.aggregate = exports.labTests = exports.user = exports.link = void 0;
 exports.link = __importStar(require("./link"));
 __exportStar(require("./link/types"), exports);
+exports.user = __importStar(require("./user"));
+__exportStar(require("./user/types"), exports);
 exports.labTests = __importStar(require("./labTests"));
 __exportStar(require("./labTests/types"), exports);
 exports.aggregate = __importStar(require("./aggregate"));
 __exportStar(require("./aggregate/types"), exports);
 exports.vitals = __importStar(require("./vitals"));
-exports.user = __importStar(require("./user"));
 exports.team = __importStar(require("./team"));
 exports.providers = __importStar(require("./providers"));
 exports.insurance = __importStar(require("./insurance"));

package/serialization/resources/user/client/requests/CreateUserPortalUrlBody.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../index";
+import * as Vital from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { CreateUserPortalUrlBodyContext } from "../../types/CreateUserPortalUrlBodyContext";
+export declare const CreateUserPortalUrlBody: core.serialization.Schema<serializers.CreateUserPortalUrlBody.Raw, Vital.CreateUserPortalUrlBody>;
+export declare namespace CreateUserPortalUrlBody {
+    interface Raw {
+        context: CreateUserPortalUrlBodyContext.Raw;
+        order_id?: string | null;
+    }
+}

package/serialization/resources/user/client/requests/CreateUserPortalUrlBody.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateUserPortalUrlBody = void 0;
+const core = __importStar(require("../../../../../core"));
+const CreateUserPortalUrlBodyContext_1 = require("../../types/CreateUserPortalUrlBodyContext");
+exports.CreateUserPortalUrlBody = core.serialization.object({
+    context: CreateUserPortalUrlBodyContext_1.CreateUserPortalUrlBodyContext,
+    orderId: core.serialization.property("order_id", core.serialization.string().optional()),
+});