@tryvital/vital-node 3.1.68 → 3.1.70

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

@@ -3,35 +3,47 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vital from "../../..";
+import * as Vital from "../../../index";
 export declare namespace User {
     interface Options {
         environment?: core.Supplier<environments.VitalEnvironment | string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class User {
     protected readonly _options: User.Options;
-    constructor(_options: User.Options);
+    constructor(_options?: User.Options);
     /**
      * GET All users for team.
+     *
+     * @param {Vital.UserGetAllRequest} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getAll()
+     *     await client.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.
+     *
+     * @param {Vital.UserCreateBody} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.BadRequestError}
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.create({
+     *     await client.user.create({
      *         clientUserId: "client_user_id"
      *     })
      */
@@ -39,59 +51,86 @@ export declare class User {
     /**
      * GET metrics for team.
      *
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
-     *     await vital.user.getTeamMetrics()
+     *     await client.user.getTeamMetrics()
      */
     getTeamMetrics(requestOptions?: User.RequestOptions): Promise<Vital.MetricsResult>;
     /**
+     * @param {string} userId
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getUserSignInToken("user_id")
+     *     await client.user.getUserSignInToken("user_id")
      */
     getUserSignInToken(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.UserSignInTokenResponse>;
     /**
      * GET Users connected providers
+     *
+     * @param {string} userId
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getConnectedProviders("user_id")
+     *     await client.user.getConnectedProviders("user_id")
      */
     getConnectedProviders(userId: string, requestOptions?: User.RequestOptions): Promise<Record<string, Vital.ClientFacingProviderWithStatus[]>>;
     /**
      * GET User details given the user_id.
+     *
+     * @param {string} userId
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.get("user_id")
+     *     await client.user.get("user_id")
      */
     get(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingUser>;
     /**
+     * @param {string} userId
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.delete("user_id")
+     *     await client.user.delete("user_id")
      */
     delete(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
+     * @param {string} userId
+     * @param {Vital.UserPatchBody} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.patch("user_id")
+     *     await client.user.patch("user_id")
      */
     patch(userId: string, request?: Vital.UserPatchBody, requestOptions?: User.RequestOptions): Promise<void>;
     /**
+     * @param {string} userId
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getLatestUserInfo("user_id")
+     *     await client.user.getLatestUserInfo("user_id")
      */
     getLatestUserInfo(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.UserInfo>;
     /**
+     * @param {string} userId
+     * @param {Vital.CreateInsuranceRequest} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.createInsurance("user_id", {
+     *     await client.user.createInsurance("user_id", {
      *         payorCode: "payor_code",
      *         memberId: "member_id",
      *         relationship: Vital.ResponsibleRelationship.Self,
@@ -114,17 +153,24 @@ export declare class User {
      */
     createInsurance(userId: string, request: Vital.CreateInsuranceRequest, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingInsurance>;
     /**
+     * @param {string} userId
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getLatestInsurance("user_id")
+     *     await client.user.getLatestInsurance("user_id")
      */
     getLatestInsurance(userId: string, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingInsurance>;
     /**
+     * @param {string} userId
+     * @param {Vital.UserInfoCreateRequest} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.upsertUserInfo("user_id", {
+     *     await client.user.upsertUserInfo("user_id", {
      *         firstName: "first_name",
      *         lastName: "last_name",
      *         email: "email",
@@ -143,36 +189,52 @@ export declare class User {
     upsertUserInfo(userId: string, request: Vital.UserInfoCreateRequest, requestOptions?: User.RequestOptions): Promise<Vital.UserInfo>;
     /**
      * GET user_id from client_user_id.
+     *
+     * @param {string} clientUserId - A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.getByClientUserId("client_user_id")
+     *     await client.user.getByClientUserId("client_user_id")
      */
     getByClientUserId(clientUserId: string, requestOptions?: User.RequestOptions): Promise<Vital.ClientFacingUser>;
     /**
+     * @param {string} userId
+     * @param {Vital.Providers} provider - Provider slug. e.g., `oura`, `fitbit`, `garmin`.
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.deregisterProvider("user_id", Vital.Providers.Oura)
+     *     await client.user.deregisterProvider("user_id", Vital.Providers.Oura)
      */
     deregisterProvider(userId: string, provider: Vital.Providers, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
+     * @param {Vital.UserUndoDeleteRequest} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.undoDelete()
+     *     await client.user.undoDelete()
      */
     undoDelete(request?: Vital.UserUndoDeleteRequest, requestOptions?: User.RequestOptions): Promise<Vital.UserSuccessResponse>;
     /**
      * Trigger a manual refresh for a specific user
+     *
+     * @param {string} userId
+     * @param {Vital.UserRefreshRequest} request
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vital.BadRequestError}
      * @throws {@link Vital.UnprocessableEntityError}
      *
      * @example
-     *     await vital.user.refresh("user_id")
+     *     await client.user.refresh("user_id")
      */
     refresh(userId: string, request?: Vital.UserRefreshRequest, requestOptions?: User.RequestOptions): Promise<Vital.UserRefreshSuccessResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-vital-api-key": string;
+        "x-vital-api-key": string | undefined;
     }>;
 }