@tryvital/vital-node 3.1.7 → 3.1.8

package/api/resources/link/client/Client.d.ts

@@ -25,21 +25,42 @@ export declare class Link {
      * like to redirect to a custom url after successful or error connection,
      * pass in your own custom redirect_url parameter.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.token({
+     *         userId: "user_id"
+     *     })
      */
     token(request: Vital.LinkTokenExchange, requestOptions?: Link.RequestOptions): Promise<Vital.LinkTokenExchangeResponse>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.isTokenValid({
+     *         token: "token"
+     *     })
      */
     isTokenValid(request: Vital.LinkTokenBase, requestOptions?: Link.RequestOptions): Promise<Record<string, unknown>>;
     /**
      * Generate a token to invite a user of Vital mobile app to your team
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.codeCreate({
+     *         userId: "user_id"
+     *     })
      */
     codeCreate(request: Vital.LinkCodeCreateRequest, requestOptions?: Link.RequestOptions): Promise<Vital.VitalTokenCreatedResponse>;
     /**
      * REQUEST_SOURCE: VITAL-LINK
      * Start link token process
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.startConnect({
+     *         linkToken: "link_token",
+     *         provider: Vital.Providers.Oura
+     *     })
      */
     startConnect(request: Vital.BeginLinkTokenRequest, requestOptions?: Link.RequestOptions): Promise<Record<string, unknown>>;
     /**
@@ -54,26 +75,55 @@ export declare class Link {
     /**
      * Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.emailAuth({
+     *         email: "email",
+     *         provider: Vital.Providers.Oura,
+     *         authType: Vital.AuthType.Password
+     *     })
      */
     emailAuth(request: Vital.EmailAuthLink, requestOptions?: Link.RequestOptions): Promise<Vital.ConnectionStatus>;
     /**
      * Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.passwordAuth({
+     *         username: "username",
+     *         password: "password",
+     *         provider: Vital.Providers.Oura,
+     *         authType: Vital.AuthType.Password
+     *     })
      */
     passwordAuth(request: Vital.PasswordAuthLink, requestOptions?: Link.RequestOptions): Promise<Vital.ConnectionStatus>;
     /**
      * This endpoint generates an OAuth link for oauth provider
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.generateOauthLink(Vital.OAuthProviders.Oura)
      */
     generateOauthLink(oauthProvider: Vital.OAuthProviders, request?: Vital.LinkGenerateOauthLinkRequest, requestOptions?: Link.RequestOptions): Promise<Vital.Source>;
     /**
      * This connects auth providers that are password based.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectPasswordProvider(Vital.PasswordProviders.Whoop, {
+     *         username: "username",
+     *         password: "password"
+     *     })
      */
     connectPasswordProvider(provider: Vital.PasswordProviders, request: Vital.IndividualProviderData, requestOptions?: Link.RequestOptions): Promise<Vital.ProviderLinkResponse>;
     /**
      * This connects auth providers that are email based.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectEmailAuthProvider("freestyle_libre", {
+     *         email: "email"
+     *     })
      */
     connectEmailAuthProvider(provider: Vital.EmailProviders, request: Vital.EmailProviderAuthLink, requestOptions?: Link.RequestOptions): Promise<Vital.ConnectionStatus>;
     /**
@@ -86,11 +136,22 @@ export declare class Link {
     getAllProviders(request?: Vital.LinkGetAllProvidersRequest, requestOptions?: Link.RequestOptions): Promise<Vital.SourceLink[]>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectManualProvider(Vital.ManualProviders.BeurerBle, {
+     *         userId: "user_id"
+     *     })
      */
     connectManualProvider(provider: Vital.ManualProviders, request: Vital.ManualConnectionData, requestOptions?: Link.RequestOptions): Promise<Record<string, boolean>>;
     /**
      * POST Connect the given Vital user to a demo provider.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectDemoProvider({
+     *         userId: "user_id",
+     *         provider: Vital.DemoProviders.AppleHealthKit
+     *     })
      */
     connectDemoProvider(request: Vital.DemoConnectionCreationPayload, requestOptions?: Link.RequestOptions): Promise<Vital.DemoConnectionStatus>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/api/resources/link/client/Client.js

@@ -68,6 +68,11 @@ class Link {
      * like to redirect to a custom url after successful or error connection,
      * pass in your own custom redirect_url parameter.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.token({
+     *         userId: "user_id"
+     *     })
      */
     token(request, requestOptions) {
         var _a;
@@ -75,7 +80,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/token"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.LinkTokenExchange.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -122,6 +127,11 @@ class Link {
     }
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.isTokenValid({
+     *         token: "token"
+     *     })
      */
     isTokenValid(request, requestOptions) {
         var _a;
@@ -129,7 +139,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/token/isValid"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.LinkTokenBase.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -177,6 +187,11 @@ class Link {
     /**
      * Generate a token to invite a user of Vital mobile app to your team
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.codeCreate({
+     *         userId: "user_id"
+     *     })
      */
     codeCreate(request, requestOptions) {
         var _a;
@@ -190,7 +205,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/code/create"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -239,6 +254,12 @@ class Link {
      * REQUEST_SOURCE: VITAL-LINK
      * Start link token process
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.startConnect({
+     *         linkToken: "link_token",
+     *         provider: Vital.Providers.Oura
+     *     })
      */
     startConnect(request, requestOptions) {
         var _a;
@@ -246,7 +267,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/start"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.BeginLinkTokenRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -306,7 +327,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/state"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -353,6 +374,13 @@ class Link {
     /**
      * Deprecated. Use `POST /v2/link/provider/email/{provider}` instead.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.emailAuth({
+     *         email: "email",
+     *         provider: Vital.Providers.Oura,
+     *         authType: Vital.AuthType.Password
+     *     })
      */
     emailAuth(request, requestOptions) {
         var _a;
@@ -361,7 +389,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/auth/email"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.EmailAuthLink.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -409,6 +437,14 @@ class Link {
     /**
      * Deprecated. Use `POST /v2/link/provider/password/{provider}` instead.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.passwordAuth({
+     *         username: "username",
+     *         password: "password",
+     *         provider: Vital.Providers.Oura,
+     *         authType: Vital.AuthType.Password
+     *     })
      */
     passwordAuth(request, requestOptions) {
         var _a;
@@ -417,7 +453,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/auth"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PasswordAuthLink.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -465,6 +501,9 @@ class Link {
     /**
      * This endpoint generates an OAuth link for oauth provider
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.generateOauthLink(Vital.OAuthProviders.Oura)
      */
     generateOauthLink(oauthProvider, request = {}, requestOptions) {
         var _a;
@@ -473,7 +512,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/link/provider/oauth/${yield serializers.OAuthProviders.jsonOrThrow(oauthProvider)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -520,6 +559,12 @@ class Link {
     /**
      * This connects auth providers that are password based.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectPasswordProvider(Vital.PasswordProviders.Whoop, {
+     *         username: "username",
+     *         password: "password"
+     *     })
      */
     connectPasswordProvider(provider, request, requestOptions) {
         var _a;
@@ -528,7 +573,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/link/provider/password/${yield serializers.PasswordProviders.jsonOrThrow(provider)}`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-client-region": vitalLinkClientRegion != null ? vitalLinkClientRegion : undefined, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-client-region": vitalLinkClientRegion != null ? vitalLinkClientRegion : undefined, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.IndividualProviderData.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -576,6 +621,11 @@ class Link {
     /**
      * This connects auth providers that are email based.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectEmailAuthProvider("freestyle_libre", {
+     *         email: "email"
+     *     })
      */
     connectEmailAuthProvider(provider, request, requestOptions) {
         var _a;
@@ -584,7 +634,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/link/provider/email/${yield serializers.EmailProviders.jsonOrThrow(provider)}`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.EmailProviderAuthLink.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -643,7 +693,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/providers"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -689,6 +739,11 @@ class Link {
     }
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectManualProvider(Vital.ManualProviders.BeurerBle, {
+     *         userId: "user_id"
+     *     })
      */
     connectManualProvider(provider, request, requestOptions) {
         var _a;
@@ -696,7 +751,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/link/provider/manual/${yield serializers.ManualProviders.jsonOrThrow(provider)}`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.ManualConnectionData.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -744,6 +799,12 @@ class Link {
     /**
      * POST Connect the given Vital user to a demo provider.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.link.connectDemoProvider({
+     *         userId: "user_id",
+     *         provider: Vital.DemoProviders.AppleHealthKit
+     *     })
      */
     connectDemoProvider(request, requestOptions) {
         var _a;
@@ -751,7 +812,7 @@ class Link {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, "v2/link/connect/demo"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DemoConnectionCreationPayload.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",

package/api/resources/link/client/requests/BeginLinkTokenRequest.d.ts

@@ -2,6 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vital from "../../../..";
+/**
+ * @example
+ *     {
+ *         linkToken: "link_token",
+ *         provider: Vital.Providers.Oura
+ *     }
+ */
 export interface BeginLinkTokenRequest {
     linkToken: string;
     provider: Vital.Providers;

package/api/resources/link/client/requests/DemoConnectionCreationPayload.d.ts

@@ -2,6 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vital from "../../../..";
+/**
+ * @example
+ *     {
+ *         userId: "user_id",
+ *         provider: Vital.DemoProviders.AppleHealthKit
+ *     }
+ */
 export interface DemoConnectionCreationPayload {
     /** Vital user ID */
     userId: string;

package/api/resources/link/client/requests/EmailAuthLink.d.ts

@@ -2,6 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vital from "../../../..";
+/**
+ * @example
+ *     {
+ *         email: "email",
+ *         provider: Vital.Providers.Oura,
+ *         authType: Vital.AuthType.Password
+ *     }
+ */
 export interface EmailAuthLink {
     vitalLinkToken?: string;
     email: string;

package/api/resources/link/client/requests/EmailProviderAuthLink.d.ts

@@ -2,6 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vital from "../../../..";
+/**
+ * @example
+ *     {
+ *         email: "email"
+ *     }
+ */
 export interface EmailProviderAuthLink {
     vitalLinkToken?: string;
     email: string;

package/api/resources/link/client/requests/IndividualProviderData.d.ts

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         username: "username",
+ *         password: "password"
+ *     }
+ */
 export interface IndividualProviderData {
     vitalLinkClientRegion?: string;
     vitalLinkToken?: string;

package/api/resources/link/client/requests/LinkCodeCreateRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         userId: "user_id"
+ *     }
+ */
 export interface LinkCodeCreateRequest {
     userId: string;
     expiresAt?: Date;

package/api/resources/link/client/requests/LinkGenerateOauthLinkRequest.d.ts

@@ -1,6 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {}
+ */
 export interface LinkGenerateOauthLinkRequest {
     vitalLinkToken?: string;
 }

package/api/resources/link/client/requests/LinkTokenBase.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         token: "token"
+ *     }
+ */
 export interface LinkTokenBase {
     token: string;
     isUsed?: boolean;

package/api/resources/link/client/requests/LinkTokenExchange.d.ts

@@ -2,6 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vital from "../../../..";
+/**
+ * @example
+ *     {
+ *         userId: "user_id"
+ *     }
+ */
 export interface LinkTokenExchange {
     /** User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. */
     userId: string;

package/api/resources/link/client/requests/ManualConnectionData.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         userId: "user_id"
+ *     }
+ */
 export interface ManualConnectionData {
     userId: string;
     providerId?: string;

package/api/resources/link/client/requests/PasswordAuthLink.d.ts

@@ -2,6 +2,15 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vital from "../../../..";
+/**
+ * @example
+ *     {
+ *         username: "username",
+ *         password: "password",
+ *         provider: Vital.Providers.Oura,
+ *         authType: Vital.AuthType.Password
+ *     }
+ */
 export interface PasswordAuthLink {
     vitalLinkToken?: string;
     username: string;

package/api/resources/meal/client/Client.d.ts

@@ -22,8 +22,8 @@ export declare class Meal {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.meal.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.meal.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId: string, request: Vital.MealGetRequest, requestOptions?: Meal.RequestOptions): Promise<Vital.ClientFacingMealResponse>;

package/api/resources/meal/client/Client.js

@@ -54,8 +54,8 @@ class Meal {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.meal.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.meal.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId, request, requestOptions) {
@@ -73,7 +73,7 @@ class Meal {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/meal/${userId}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/meal/client/requests/MealGetRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         startDate: "start-date"
+ *         startDate: "start_date"
  *     }
  */
 export interface MealGetRequest {

package/api/resources/profile/client/Client.d.ts

@@ -20,11 +20,17 @@ export declare class Profile {
     /**
      * Get Daily profile for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.profile.get("user_id")
      */
     get(userId: string, request?: Vital.ProfileGetRequest, requestOptions?: Profile.RequestOptions): Promise<Vital.ClientFacingProfile>;
     /**
      * Get Daily profile for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.profile.getRaw("user_id")
      */
     getRaw(userId: string, request?: Vital.ProfileGetRawRequest, requestOptions?: Profile.RequestOptions): Promise<Vital.RawProfile>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/api/resources/profile/client/Client.js

@@ -52,6 +52,9 @@ class Profile {
     /**
      * Get Daily profile for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.profile.get("user_id")
      */
     get(userId, request = {}, requestOptions) {
         var _a;
@@ -64,7 +67,7 @@ class Profile {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/profile/${userId}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -112,6 +115,9 @@ class Profile {
     /**
      * Get Daily profile for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.profile.getRaw("user_id")
      */
     getRaw(userId, request = {}, requestOptions) {
         var _a;
@@ -124,7 +130,7 @@ class Profile {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VitalEnvironment.Production, `v2/summary/profile/${userId}/raw`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@tryvital/vital-node", "X-Fern-SDK-Version": "3.1.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,