@tryvital/vital-node 3.0.7 → 3.0.9

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

@@ -42,7 +42,6 @@ exports.Sleep = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const Vital = __importStar(require("../../.."));
-const url_search_params_1 = __importDefault(require("@ungap/url-search-params"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization"));
 const errors = __importStar(require("../../../../errors"));
@@ -53,18 +52,23 @@ class Sleep {
     /**
      * Get Daily sleep for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.sleep.get("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     get(userId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { provider, startDate, endDate } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (provider != null) {
-                _queryParams.append("provider", provider);
+                _queryParams["provider"] = provider;
             }
-            _queryParams.append("start_date", startDate);
+            _queryParams["start_date"] = startDate;
             if (endDate != null) {
-                _queryParams.append("end_date", endDate);
+                _queryParams["end_date"] = endDate;
             }
             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/sleep/${userId}`),
@@ -73,11 +77,12 @@ class Sleep {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.ClientSleepResponse.parseOrThrow(_response.body, {
@@ -121,18 +126,23 @@ class Sleep {
     /**
      * Get Daily sleep stream for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.sleep.getStream("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     getStream(userId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { provider, startDate, endDate } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (provider != null) {
-                _queryParams.append("provider", provider);
+                _queryParams["provider"] = provider;
             }
-            _queryParams.append("start_date", startDate);
+            _queryParams["start_date"] = startDate;
             if (endDate != null) {
-                _queryParams.append("end_date", endDate);
+                _queryParams["end_date"] = endDate;
             }
             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/sleep/${userId}/stream`),
@@ -141,11 +151,12 @@ class Sleep {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.ClientSleepResponse.parseOrThrow(_response.body, {
@@ -189,18 +200,23 @@ class Sleep {
     /**
      * Get Daily sleep for user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.sleep.getRaw("user-id", {
+     *         startDate: "start-date"
+     *     })
      */
     getRaw(userId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { provider, startDate, endDate } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (provider != null) {
-                _queryParams.append("provider", provider);
+                _queryParams["provider"] = provider;
             }
-            _queryParams.append("start_date", startDate);
+            _queryParams["start_date"] = startDate;
             if (endDate != null) {
-                _queryParams.append("end_date", endDate);
+                _queryParams["end_date"] = endDate;
             }
             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/sleep/${userId}/raw`),
@@ -209,11 +225,12 @@ class Sleep {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.RawSleep.parseOrThrow(_response.body, {
@@ -257,6 +274,9 @@ class Sleep {
     /**
      * Get Sleep stream for a user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.sleep.getStreamBySleepId("sleep-id")
      */
     getStreamBySleepId(sleepId, requestOptions) {
         var _a;
@@ -268,10 +288,11 @@ class Sleep {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 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,
             });
             if (_response.ok) {
                 return yield serializers.ClientFacingSleepStream.parseOrThrow(_response.body, {

package/api/resources/sleep/client/requests/SleepGetRawRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface SleepGetRawRequest {
     /**
      * Provider oura/strava etc

package/api/resources/sleep/client/requests/SleepGetRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface SleepGetRequest {
     /**
      * Provider oura/strava etc

package/api/resources/sleep/client/requests/SleepGetStreamRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         startDate: "start-date"
+ *     }
+ */
 export interface SleepGetStreamRequest {
     /**
      * Provider oura/strava etc

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

@@ -11,6 +11,7 @@ export declare namespace Team {
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
+        maxRetries?: number;
     }
 }
 export declare class Team {
@@ -19,6 +20,9 @@ export declare class Team {
     /**
      * Post teams.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getLinkConfig({})
      */
     getLinkConfig(request?: Vital.TeamGetLinkConfigRequest, requestOptions?: Team.RequestOptions): Promise<Record<string, unknown>>;
     /**
@@ -29,21 +33,35 @@ export declare class Team {
     /**
      * Search team users by user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getUserById({})
      */
     getUserById(request?: Vital.TeamGetUserByIdRequest, requestOptions?: Team.RequestOptions): Promise<Vital.ClientFacingUser[]>;
     getSvixUrl(requestOptions?: Team.RequestOptions): Promise<Record<string, unknown>>;
     /**
      * GET source priorities.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getSourcePriorities({})
      */
     getSourcePriorities(request?: Vital.TeamGetSourcePrioritiesRequest, requestOptions?: Team.RequestOptions): Promise<Record<string, unknown>[]>;
     /**
      * Patch source priorities.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.updateSourcePriorities({
+     *         teamId: "team-id"
+     *     })
      */
     updateSourcePriorities(request: Vital.TeamUpdateSourcePrioritiesRequest, requestOptions?: Team.RequestOptions): Promise<Record<string, unknown>[]>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getPhysicians("team-id")
      */
     getPhysicians(teamId: string, requestOptions?: Team.RequestOptions): Promise<Vital.ClientFacingPhysician[]>;
 }

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

@@ -45,7 +45,6 @@ const Vital = __importStar(require("../../.."));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization"));
 const errors = __importStar(require("../../../../errors"));
-const url_search_params_1 = __importDefault(require("@ungap/url-search-params"));
 class Team {
     constructor(_options) {
         this._options = _options;
@@ -53,6 +52,9 @@ class Team {
     /**
      * Post teams.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getLinkConfig({})
      */
     getLinkConfig(request = {}, requestOptions) {
         var _a;
@@ -65,11 +67,12 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                     "x-vital-link-token": vitalLinkToken != null ? vitalLinkToken : undefined,
                 },
                 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,
             });
             if (_response.ok) {
                 return yield serializers.team.getLinkConfig.Response.parseOrThrow(_response.body, {
@@ -124,10 +127,11 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 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,
             });
             if (_response.ok) {
                 return yield serializers.ClientFacingTeam.parseOrThrow(_response.body, {
@@ -171,14 +175,17 @@ class Team {
     /**
      * Search team users by user_id
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getUserById({})
      */
     getUserById(request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { queryId } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (queryId != null) {
-                _queryParams.append("query_id", queryId);
+                _queryParams["query_id"] = queryId;
             }
             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/team/users/search"),
@@ -187,11 +194,12 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.team.getUserById.Response.parseOrThrow(_response.body, {
@@ -242,10 +250,11 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 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,
             });
             if (_response.ok) {
                 return yield serializers.team.getSvixUrl.Response.parseOrThrow(_response.body, {
@@ -279,14 +288,17 @@ class Team {
     /**
      * GET source priorities.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getSourcePriorities({})
      */
     getSourcePriorities(request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { dataType } = request;
-            const _queryParams = new url_search_params_1.default();
+            const _queryParams = {};
             if (dataType != null) {
-                _queryParams.append("data_type", dataType);
+                _queryParams["data_type"] = dataType;
             }
             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/team/source/priorities"),
@@ -295,11 +307,12 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.team.getSourcePriorities.Response.parseOrThrow(_response.body, {
@@ -343,13 +356,18 @@ class Team {
     /**
      * Patch source priorities.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.updateSourcePriorities({
+     *         teamId: "team-id"
+     *     })
      */
     updateSourcePriorities(request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { teamId } = request;
-            const _queryParams = new url_search_params_1.default();
-            _queryParams.append("team_id", teamId);
+            const _queryParams = {};
+            _queryParams["team_id"] = teamId;
             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/team/source/priorities"),
                 method: "PATCH",
@@ -357,11 +375,12 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 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,
             });
             if (_response.ok) {
                 return yield serializers.team.updateSourcePriorities.Response.parseOrThrow(_response.body, {
@@ -404,6 +423,9 @@ class Team {
     }
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.getPhysicians("team-id")
      */
     getPhysicians(teamId, requestOptions) {
         var _a;
@@ -415,10 +437,11 @@ class Team {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 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,
             });
             if (_response.ok) {
                 return yield serializers.team.getPhysicians.Response.parseOrThrow(_response.body, {

package/api/resources/team/client/requests/TeamGetLinkConfigRequest.d.ts

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

package/api/resources/team/client/requests/TeamGetSourcePrioritiesRequest.d.ts

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

package/api/resources/team/client/requests/TeamGetUserByIdRequest.d.ts

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

package/api/resources/team/client/requests/TeamUpdateSourcePrioritiesRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         teamId: "team-id"
+ *     }
+ */
 export interface TeamUpdateSourcePrioritiesRequest {
     teamId: string;
 }

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

@@ -11,6 +11,7 @@ export declare namespace Testkit {
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
+        maxRetries?: number;
     }
 }
 export declare class Testkit {

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

@@ -62,11 +62,12 @@ class Testkit {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.RegisterTestkitRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 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,
             });
             if (_response.ok) {
                 return yield serializers.PostOrderResponse.parseOrThrow(_response.body, {
@@ -121,13 +122,14 @@ class Testkit {
                     "x-vital-api-key": yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@tryvital/vital-node",
-                    "X-Fern-SDK-Version": "3.0.7",
+                    "X-Fern-SDK-Version": "3.0.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.CreateRegistrableTestkitOrderRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 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,
             });
             if (_response.ok) {
                 return yield serializers.PostOrderResponse.parseOrThrow(_response.body, {

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

@@ -11,6 +11,7 @@ export declare namespace User {
     }
     interface RequestOptions {
         timeoutInSeconds?: number;
+        maxRetries?: number;
     }
 }
 export declare class User {
@@ -37,6 +38,9 @@ export declare class User {
     /**
      * GET Users connected providers
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.getConnectedProviders("user-id")
      */
     getConnectedProviders(userId: string, requestOptions?: User.RequestOptions): Promise<Record<string, Vital.ClientFacingProviderWithStatus[]>>;
     /**
@@ -50,6 +54,9 @@ export declare class User {
     delete(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.patch("user-id", {})
      */
     patch(userId: string, request?: Vital.UserPatchBody, requestOptions?: User.RequestOptions): Promise<void>;
     /**