@tryvital/vital-node 3.1.7 → 3.1.8

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

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

package/dist/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/dist/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,

package/dist/api/resources/profile/client/requests/ProfileGetRawRequest.d.ts

@@ -1,6 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {}
+ */
 export interface ProfileGetRawRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/profile/client/requests/ProfileGetRequest.d.ts

@@ -1,6 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {}
+ */
 export interface ProfileGetRequest {
     /**
      * Provider oura/strava etc

package/dist/api/resources/providers/client/Client.js

@@ -60,7 +60,7 @@ class Providers {
             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/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 }, (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",
                 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,

package/dist/api/resources/sleep/client/Client.d.ts

@@ -22,8 +22,8 @@ export declare class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.sleep.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId: string, request: Vital.SleepGetRequest, requestOptions?: Sleep.RequestOptions): Promise<Vital.ClientSleepResponse>;
@@ -32,8 +32,8 @@ export declare class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.getStream("user-id", {
-     *         startDate: "start-date"
+     *     await vital.sleep.getStream("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getStream(userId: string, request: Vital.SleepGetStreamRequest, requestOptions?: Sleep.RequestOptions): Promise<Vital.ClientSleepResponse>;
@@ -42,8 +42,8 @@ export declare class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.sleep.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId: string, request: Vital.SleepGetRawRequest, requestOptions?: Sleep.RequestOptions): Promise<Vital.RawSleep>;
@@ -52,7 +52,7 @@ export declare class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.getStreamBySleepId("sleep-id")
+     *     await vital.sleep.getStreamBySleepId("sleep_id")
      */
     getStreamBySleepId(sleepId: string, requestOptions?: Sleep.RequestOptions): Promise<Vital.ClientFacingSleepStream>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -54,8 +54,8 @@ class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.get("user-id", {
-     *         startDate: "start-date"
+     *     await vital.sleep.get("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     get(userId, request, requestOptions) {
@@ -73,7 +73,7 @@ class Sleep {
             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}`),
                 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,
@@ -123,8 +123,8 @@ class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.getStream("user-id", {
-     *         startDate: "start-date"
+     *     await vital.sleep.getStream("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getStream(userId, request, requestOptions) {
@@ -142,7 +142,7 @@ class Sleep {
             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`),
                 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,
@@ -192,8 +192,8 @@ class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.getRaw("user-id", {
-     *         startDate: "start-date"
+     *     await vital.sleep.getRaw("user_id", {
+     *         startDate: "start_date"
      *     })
      */
     getRaw(userId, request, requestOptions) {
@@ -211,7 +211,7 @@ class Sleep {
             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`),
                 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,
@@ -261,7 +261,7 @@ class Sleep {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.sleep.getStreamBySleepId("sleep-id")
+     *     await vital.sleep.getStreamBySleepId("sleep_id")
      */
     getStreamBySleepId(sleepId, requestOptions) {
         var _a;
@@ -269,7 +269,7 @@ class Sleep {
             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/timeseries/sleep/${sleepId}/stream`),
                 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",
                 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,

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

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

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

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

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

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

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

@@ -28,6 +28,9 @@ export declare class Team {
     /**
      * Get team.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.get("team_id")
      */
     get(teamId: string, requestOptions?: Team.RequestOptions): Promise<Vital.ClientFacingTeam>;
     /**
@@ -53,7 +56,7 @@ export declare class Team {
      *
      * @example
      *     await vital.team.updateSourcePriorities({
-     *         teamId: "team-id"
+     *         teamId: "team_id"
      *     })
      */
     updateSourcePriorities(request: Vital.TeamUpdateSourcePrioritiesRequest, requestOptions?: Team.RequestOptions): Promise<Record<string, unknown>[]>;
@@ -61,7 +64,7 @@ export declare class Team {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.team.getPhysicians("team-id")
+     *     await vital.team.getPhysicians("team_id")
      */
     getPhysicians(teamId: string, requestOptions?: Team.RequestOptions): Promise<Vital.ClientFacingPhysician[]>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -63,7 +63,7 @@ class Team {
             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/link/config"),
                 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,
@@ -110,6 +110,9 @@ class Team {
     /**
      * Get team.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.team.get("team_id")
      */
     get(teamId, requestOptions) {
         var _a;
@@ -117,7 +120,7 @@ class Team {
             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/${teamId}`),
                 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",
                 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,
@@ -179,7 +182,7 @@ class Team {
             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"),
                 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,
@@ -230,7 +233,7 @@ class Team {
             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/svix/url"),
                 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",
                 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,
@@ -282,7 +285,7 @@ class Team {
             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: "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,
@@ -333,7 +336,7 @@ class Team {
      *
      * @example
      *     await vital.team.updateSourcePriorities({
-     *         teamId: "team-id"
+     *         teamId: "team_id"
      *     })
      */
     updateSourcePriorities(request, requestOptions) {
@@ -345,7 +348,7 @@ class Team {
             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",
-                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,
@@ -394,7 +397,7 @@ class Team {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.team.getPhysicians("team-id")
+     *     await vital.team.getPhysicians("team_id")
      */
     getPhysicians(teamId, requestOptions) {
         var _a;
@@ -402,7 +405,7 @@ class Team {
             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/${teamId}/physicians`),
                 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",
                 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,

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

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         teamId: "team-id"
+ *         teamId: "team_id"
  *     }
  */
 export interface TeamUpdateSourcePrioritiesRequest {

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

@@ -58,7 +58,7 @@ class Testkit {
             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, "v3/order/testkit/register"),
                 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.RegisterTestkitRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -113,7 +113,7 @@ class Testkit {
             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, "v3/order/testkit"),
                 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.CreateRegistrableTestkitOrderRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",

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

@@ -20,20 +20,34 @@ export declare class User {
     /**
      * GET All users for team.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.getAll()
      */
     getAll(request?: Vital.UserGetAllRequest, requestOptions?: User.RequestOptions): Promise<Vital.PaginatedUsersResponse>;
     /**
      * POST Create a Vital user given a client_user_id and returns the user_id.
      * @throws {@link Vital.BadRequestError}
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.create({
+     *         clientUserId: "client_user_id"
+     *     })
      */
     create(request: Vital.UserCreateBody, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingUserKey>;
     /**
      * GET metrics for team.
+     *
+     * @example
+     *     await vital.user.getTeamMetrics()
      */
     getTeamMetrics(requestOptions?: User.RequestOptions): Promise<Vital.MetricsResult>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.getUserSignInToken("user_id")
      */
     getUserSignInToken(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.UserSignInTokenResponse>;
     /**
@@ -41,42 +55,60 @@ export declare class User {
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getConnectedProviders("user-id")
+     *     await vital.user.getConnectedProviders("user_id")
      */
     getConnectedProviders(userId: string, requestOptions?: User.RequestOptions): Promise<Record<string, Vital.ClientFacingProviderWithStatus[]>>;
     /**
      * GET User details given the user_id.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.get("user_id")
      */
     get(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingUser>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.delete("user_id")
      */
     delete(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.patch("user-id")
+     *     await vital.user.patch("user_id")
      */
     patch(userId: string, request?: Vital.UserPatchBody, requestOptions?: User.RequestOptions): Promise<void>;
     /**
      * GET user_id from client_user_id.
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.getByClientUserId("client_user_id")
      */
     getByClientUserId(clientUserId: string, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingUser>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.deregisterProvider("user_id", Vital.Providers.Oura)
      */
     deregisterProvider(userId: string, provider: Vital.Providers, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.undoDelete()
      */
     undoDelete(request?: Vital.UserUndoDeleteRequest, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
      * Trigger a manual refresh for a specific user
      * @throws {@link Vital.BadRequestError}
      * @throws {@link Vital.UnprocessableEntityError}
+     *
+     * @example
+     *     await vital.user.refresh("user_id")
      */
     refresh(userId: string, request?: Vital.UserRefreshRequest, requestOptions?: User.RequestOptions): Promise<Vital.UserRefreshSuccessResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{