@icanbwell/bwell-sdk-ts 2.0.0-alpha.0-rc.1754330797 → 2.0.0-alpha.0-rc.1754488327

package/dist/api/base/health-space/cancellation-reasons-request.d.ts

@@ -0,0 +1,28 @@
+import { SearchReference } from "../../../graphql/schema.js";
+import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
+/**
+ * Input type for fetching cancellation reasons. Requires organization reference to get applicable reasons.
+ * @category Inputs
+ * @title CancellationReasonsRequestInput
+ * @excerpt Input for fetching cancellation reasons by organization
+ */
+export type CancellationReasonsRequestInput = {
+    organization: SearchReference;
+};
+/**
+ * Validator for CancellationReasonsRequestInput.
+ * Ensures that organization is present and has a non-empty value.
+ */
+declare class CancellationReasonsRequestValidator implements Validator<CancellationReasonsRequestInput> {
+    validate(data: CancellationReasonsRequestInput, errors: ErrorsCollector): void;
+}
+/**
+ * Request object for fetching cancellation reasons.
+ * @category Requests
+ * @title CancellationReasonsRequest
+ * @excerpt Request object for fetching cancellation reasons
+ */
+export declare class CancellationReasonsRequest extends ValidationRequest<CancellationReasonsRequestInput> {
+    protected validator: CancellationReasonsRequestValidator;
+}
+export {};

package/dist/api/base/health-space/{cancelationReasons-request.js → cancellation-reasons-request.js}

@@ -1,10 +1,10 @@
 import { ValidationRequest, } from "../../../requests/index.js";
 import { isNullOrUndefinedOrEmptyString } from "../../../utils/type-utils.js";
 /**
- * Validator for CancelationReasonsRequestInput.
+ * Validator for CancellationReasonsRequestInput.
  * Ensures that organization is present and has a non-empty value.
  */
-class CancelationReasonsRequestValidator {
+class CancellationReasonsRequestValidator {
     validate(data, errors) {
         var _a;
         if (isNullOrUndefinedOrEmptyString((_a = data.organization.value) === null || _a === void 0 ? void 0 : _a.trim())) {
@@ -12,9 +12,15 @@ class CancelationReasonsRequestValidator {
         }
     }
 }
-export class CancelationReasonsRequest extends ValidationRequest {
+/**
+ * Request object for fetching cancellation reasons.
+ * @category Requests
+ * @title CancellationReasonsRequest
+ * @excerpt Request object for fetching cancellation reasons
+ */
+export class CancellationReasonsRequest extends ValidationRequest {
     constructor() {
         super(...arguments);
-        this.validator = new CancelationReasonsRequestValidator();
+        this.validator = new CancellationReasonsRequestValidator();
     }
 }

package/dist/api/base/health-space/health-space-manager.d.ts

@@ -1,38 +1,47 @@
-import { AppointmentsQueryResults, CancelAppointmentMutationResults, CancelationReasonsQueryResults } from "../../../graphql/operations/types.js";
+import { AppointmentBundle, AppointmentUpdate, CancellationReasons } from "../../../models/health-space/index.js";
 import { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
 import { BaseManagerError } from "../errors.js";
 import { AppointmentsRequest } from "./appointments-request.js";
 import { CancelAppointmentRequest } from "./cancel-appointment-request.js";
-import { CancelationReasonsRequest } from "./cancelationReasons-request.js";
-export type AppointmentsResults = AppointmentsQueryResults["appointments"];
-export type CancelAppointmentResults = CancelAppointmentMutationResults["updateAppointment"];
-export type CancelationReasonsResults = CancelationReasonsQueryResults["cancelationReasons"];
+import { CancellationReasonsRequest } from "./cancellation-reasons-request.js";
 /**
- * Interface representing a manager for handling operations related to health spaces.
+ * Health Space Manager for appointments, scheduling, and healthcare facility management.
+ * Provides methods for managing appointments and cancelation handling.
+ * @title HealthSpaceManager
+ * @excerpt Health Space Manager for appointments, scheduling, and healthcare facility management
+ * @category Managers
  */
 export interface HealthSpaceManager {
     /**
-     * Retrieves appointment information based on the provided request.
-     *
-     * @param request - The request object containing parameters for fetching appointments.
-     * @returns A promise that resolves to a `BWellQueryResult` containing the appointment results
-     *          or an error of type `BaseManagerError`.
+     * Retrieves appointment information for the user.
+     * Gets scheduled appointments based on search criteria.
+     * @example
+     * ```typescript
+     * const appointments = await sdk.healthSpace.getAppointments({
+     *   dateRange: { start: '2024-01-01', end: '2024-12-31' }
+     * });
+     * ```
      */
-    getAppointments(request: AppointmentsRequest): Promise<BWellQueryResult<AppointmentsResults, BaseManagerError>>;
+    getAppointments(request: AppointmentsRequest): Promise<BWellQueryResult<AppointmentBundle, BaseManagerError>>;
     /**
-     * Cancels an appointment based on the provided request.
-     *
-     * @param request - The request object containing parameters for canceling an appointment.
-     * @returns A promise that resolves to a `BWellQueryResult` containing the result of canceling
-     *          the appointment or an error of type `BaseManagerError`.
+     * Cancels an existing appointment.
+     * Marks an appointment as canceled with optional reason.
+     * @example
+     * ```typescript
+     * await sdk.healthSpace.cancelAppointment({
+     *   appointmentId: '123',
+     *   reason: 'Schedule conflict'
+     * });
+     * ```
      */
-    cancelAppointment(request: CancelAppointmentRequest): Promise<BWellTransactionResult<CancelAppointmentResults, BaseManagerError>>;
+    cancelAppointment(request: CancelAppointmentRequest): Promise<BWellTransactionResult<AppointmentUpdate, BaseManagerError>>;
     /**
-     * Retrieves cancelation reasons based on the provided request.
-     *
-     * @param request - The request object containing parameters for fetching cancelation reasons.
-     * @returns A promise that resolves to a `BWellQueryResult` containing the cancelation reasons results
-     *          or an error of type `BaseManagerError`.
+     * Retrieves available cancellation reasons.
+     * Gets predefined reasons for appointment cancellation.
+     * @example
+     * ```typescript
+     * const reasons = await sdk.healthSpace.getCancellationReasons({});
+     * ```
      */
-    getCancelationReasons(request: CancelationReasonsRequest): Promise<BWellQueryResult<CancelationReasonsResults, BaseManagerError>>;
+    getCancellationReasons(request: CancellationReasonsRequest): Promise<BWellQueryResult<CancellationReasons, BaseManagerError>>;
 }

package/dist/api/base/health-space/index.d.ts

@@ -1,4 +1,4 @@
-export { AppointmentsResults, CancelAppointmentResults, HealthSpaceManager, CancelationReasonsResults, } from "./health-space-manager.js";
+export { HealthSpaceManager } from "./health-space-manager.js";
 export { AppointmentsRequest, AppointmentsRequestInput, } from "./appointments-request.js";
 export { CancelAppointmentRequest, CancelAppointmentRequestInput, } from "./cancel-appointment-request.js";
-export { CancelationReasonsRequest, CancelationReasonsRequestInput, } from "./cancelationReasons-request.js";
+export { CancellationReasonsRequest, CancellationReasonsRequestInput, } from "./cancellation-reasons-request.js";

package/dist/api/base/health-space/index.js

@@ -1,3 +1,3 @@
 export { AppointmentsRequest, } from "./appointments-request.js";
 export { CancelAppointmentRequest, } from "./cancel-appointment-request.js";
-export { CancelationReasonsRequest, } from "./cancelationReasons-request.js";
+export { CancellationReasonsRequest, } from "./cancellation-reasons-request.js";

package/dist/api/base/identity/identity-manager.d.ts

@@ -1,42 +1,129 @@
-import type { CreateGuestAccessTokenMutationResults, InitializeQueryResults, RefreshTokensQueryResults } from "../../../graphql/operations/types.js";
+import { AuthTokens, CreateGuestAccessTokenResults, RefreshTokenResults, SdkConfigurationResult } from "../../../models/identity/index.js";
 import type { BWellTransactionResult } from "../../../results/index.js";
 import type { BaseManagerError } from "../errors.js";
-export type SdkConfigurationResult = InitializeQueryResults["initSdk"];
-export type RefreshTokenResults = RefreshTokensQueryResults["refresh"];
-export type CreateGuestAccessTokenResults = CreateGuestAccessTokenMutationResults["createGuestAccessToken"];
+/**
+ * Request for creating guest access tokens
+ * @category Requests
+ * @title CreateGuestAccessTokenRequest
+ * @excerpt Request for creating guest access tokens
+ */
 export type CreateGuestAccessTokenRequest = {
     clientKey: string;
 };
+/**
+ * Request for OAuth authentication
+ * @category Requests
+ * @title OauthAuthenticateRequest
+ * @excerpt Request for OAuth authentication
+ */
 export type OauthAuthenticateRequest = {
     clientKey: string;
     jweToken: string;
 };
+/**
+ * Request for username/password authentication
+ * @category Requests
+ * @title UsernamePasswordAuthenticateRequest
+ * @excerpt Request for username/password authentication
+ */
 export type UsernamePasswordAuthenticateRequest = {
     clientKey: string;
     email: string;
     password: string;
 };
+/**
+ * Request for authorization code authentication
+ * @category Requests
+ * @title AuthCodeAuthenticateRequest
+ * @excerpt Request for authorization code authentication
+ */
 export type AuthCodeAuthenticateRequest = {
     clientKey: string;
     authCode: string;
 };
+/**
+ * Request for refreshing authentication tokens
+ * @category Requests
+ * @title RefreshTokensRequest
+ * @excerpt Request for refreshing authentication tokens
+ */
 export type RefreshTokensRequest = {
     refreshToken: string;
     clientKey: string;
 };
-export type AuthTokens = {
-    accessToken: string;
-    idToken: string;
-    refreshToken: string;
-};
 /**
- * The IdentityManager interface provides methods for initializing and authenticating the SDK.
+ * Identity Manager for SDK initialization and authentication.
+ * Provides methods for initializing the SDK and managing authentication flows.
+ * @category Managers
  */
 export interface IdentityManager {
+    /**
+     * Initializes the SDK configuration.
+     * Sets up the SDK with the provided client key and validates access.
+     * @example
+     * ```typescript
+     * await identityManager.initialize('your-client-key');
+     * ```
+     */
     initialize(clientKey: string): Promise<BWellTransactionResult<SdkConfigurationResult, BaseManagerError>>;
+    /**
+     * Authenticates using OAuth tokens.
+     * Validates OAuth credentials and establishes authenticated session.
+     * @example
+     * ```typescript
+     * const tokens = await identityManager.authenticateWithOauth({
+     *   clientKey: 'your-client-key',
+     *   jweToken: 'oauth-token'
+     * });
+     * ```
+     */
     authenticateWithOauth(authenticateRequest: OauthAuthenticateRequest): Promise<BWellTransactionResult<AuthTokens, BaseManagerError>>;
+    /**
+     * Authenticates using username and password.
+     * Validates user credentials and establishes authenticated session.
+     * @example
+     * ```typescript
+     * const tokens = await identityManager.authenticateWithUsernamePassword({
+     *   clientKey: 'your-client-key',
+     *   email: 'user@example.com',
+     *   password: 'secure-password'
+     * });
+     * ```
+     */
     authenticateWithUsernamePassword(authenticateRequest: UsernamePasswordAuthenticateRequest): Promise<BWellTransactionResult<AuthTokens, BaseManagerError>>;
+    /**
+     * Authenticates using authorization code.
+     * Exchanges authorization code for access tokens.
+     * @example
+     * ```typescript
+     * const tokens = await identityManager.authenticateWithAuthCode({
+     *   clientKey: 'your-client-key',
+     *   authCode: 'authorization-code'
+     * });
+     * ```
+     */
     authenticateWithAuthCode(authenticateRequest: AuthCodeAuthenticateRequest): Promise<BWellTransactionResult<AuthTokens, BaseManagerError>>;
+    /**
+     * Refreshes access tokens using refresh token.
+     * Obtains new access tokens without re-authentication.
+     * @example
+     * ```typescript
+     * const newTokens = await identityManager.refreshAccessToken({
+     *   clientKey: 'your-client-key',
+     *   refreshToken: 'refresh-token'
+     * });
+     * ```
+     */
     refreshAccessToken(refreshTokensRequest: RefreshTokensRequest): Promise<BWellTransactionResult<RefreshTokenResults, BaseManagerError>>;
+    /**
+     * Creates a guest access token.
+     * Generates limited-access tokens for guest users.
+     * @example
+     * ```typescript
+     * const guestToken = await identityManager.createGuestAccessToken({
+     *   clientKey: 'your-client-key'
+     * });
+     * ```
+     */
     createGuestAccessToken(createGuestAccessTokenRequest: CreateGuestAccessTokenRequest): Promise<BWellTransactionResult<CreateGuestAccessTokenResults, BaseManagerError>>;
 }

package/dist/api/base/questionnaire/index.d.ts

@@ -1,2 +1,2 @@
 export { NextQuestionRequest, NextQuestionRequestInput, } from "./next-question-request.js";
-export { NextQuestionResults, QuestionnaireManager, } from "./questionnaire-manager.js";
+export { QuestionnaireManager } from "./questionnaire-manager.js";

package/dist/api/base/questionnaire/next-question-request.d.ts

@@ -1,16 +1,22 @@
 import { NextQuestionMutationVariables } from "../../../graphql/operations/types.js";
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
 /**
- * Input type for the `nextQuestion` mutation.
+ * Input type for the `nextQuestion` mutation. Used to navigate through questionnaire questions.
+ * @title NextQuestionRequestInput
+ * @excerpt Input for navigating through questionnaire questions
  * @experimental This class is experimental and may change in future releases.
+ * @category Inputs
  */
 export type NextQuestionRequestInput = NextQuestionMutationVariables;
 declare class NextQuestionRequestValidator implements Validator<NextQuestionRequestInput> {
     validate(data: NextQuestionRequestInput, errors: ErrorsCollector): void;
 }
 /**
- * Request class for handling next question mutations.
+ * Request object for handling next question mutations.
  * @experimental This class is experimental and may change in future releases.
+ * @category Requests
+ * @title NextQuestionRequest
+ * @excerpt Request object for handling next question mutations
  */
 export declare class NextQuestionRequest extends ValidationRequest<NextQuestionRequestInput> {
     protected validator: NextQuestionRequestValidator;

package/dist/api/base/questionnaire/next-question-request.js

@@ -44,8 +44,11 @@ class NextQuestionRequestValidator {
     }
 }
 /**
- * Request class for handling next question mutations.
+ * Request object for handling next question mutations.
  * @experimental This class is experimental and may change in future releases.
+ * @category Requests
+ * @title NextQuestionRequest
+ * @excerpt Request object for handling next question mutations
  */
 export class NextQuestionRequest extends ValidationRequest {
     constructor() {

package/dist/api/base/questionnaire/questionnaire-manager.d.ts

@@ -1,19 +1,26 @@
-import { NextQuestionMutationResults } from "../../../graphql/operations/types.js";
+import { QuestionnaireResponse } from "../../../models/questionnaire/index.js";
 import { BWellTransactionResult } from "../../../results/index.js";
 import { NextQuestionRequest } from "../../base/questionnaire/next-question-request.js";
 import { BaseManagerError } from "../errors.js";
-export type NextQuestionResults = NextQuestionMutationResults["nextQuestion"];
 /**
- * Interface representing a manager for handling operations related to questionnaires.
+ * Questionnaire Manager for dynamic questionnaire processing and response handling.
+ * Provides methods for managing questionnaire workflows and form processing.
+ * @title QuestionnaireManager
+ * @excerpt Questionnaire Manager for dynamic questionnaire processing and response handling
+ * @category Managers
  */
 export interface QuestionnaireManager {
     /**
-     * Calls the nextQuestion mutation with the provided request.
+     * Processes the next question in a questionnaire flow.
+     * Advances through dynamic questionnaire based on responses.
      * @experimental This method is experimental and may change in future releases.
-     *
-     * @param request - The request object containing parameters for the mutation.
-     * @returns A promise that resolves to a `BWellTransactionResult` containing the mutation results
-     *          or an error of type `BaseManagerError`.
+     * @example
+     * ```typescript
+     * const nextQuestion = await sdk.questionnaire.nextQuestion({
+     *   questionnaireId: 'health-assessment',
+     *   responses: [{ question: 'age', answer: '35' }]
+     * });
+     * ```
      */
-    nextQuestion(request: NextQuestionRequest): Promise<BWellTransactionResult<NextQuestionResults, BaseManagerError>>;
+    nextQuestion(request: NextQuestionRequest): Promise<BWellTransactionResult<QuestionnaireResponse, BaseManagerError>>;
 }

package/dist/api/base/requests/search-date.d.ts

@@ -1,7 +1,19 @@
 import { ErrorsCollector, Validator } from "../../../requests/index.js";
+/**
+ * Search criteria for date-based filtering. Supports various date comparison operators.
+ * @category Inputs
+ * @title SearchDate
+ * @excerpt Search criteria for date-based filtering
+ */
 export type SearchDate = {
     values?: SearchDateValue[];
 };
+/**
+ * Date value with comparison operators for filtering (equals, greater than, less than, etc.).
+ * @category Inputs
+ * @title SearchDateValue
+ * @excerpt Date value with comparison operators
+ */
 export type SearchDateValue = {
     equals?: Date;
     notEquals?: Date;

package/dist/api/base/requests/search-string.d.ts

@@ -1,4 +1,10 @@
 import { ErrorsCollector, Validator } from "../../../requests/index.js";
+/**
+ * Search criteria for string-based filtering. Contains an array of string values to search for.
+ * @category Inputs
+ * @title SearchString
+ * @excerpt Search criteria for string-based filtering
+ */
 export type SearchString = {
     values?: string[];
 };

package/dist/api/base/requests/search-token.d.ts

@@ -1,12 +1,30 @@
 import { ErrorsCollector, Validator } from "../../../requests/index.js";
+/**
+ * Token value with system, code, and display for structured search criteria.
+ * @category Inputs
+ * @title SearchTokenValue
+ * @excerpt Token value with system, code, and display
+ */
 export type SearchTokenValue = {
     system?: string;
     code?: string;
     value?: string;
 };
+/**
+ * Negated search token value that extends SearchTokenValue with additional values array.
+ * @category Inputs
+ * @title NotSearchTokenValue
+ * @excerpt Negated search token value with values array
+ */
 export type NotSearchTokenValue = SearchTokenValue & {
     values?: SearchTokenValue[];
 };
+/**
+ * Search criteria for token-based filtering. Supports single values, multiple values, or negation.
+ * @category Inputs
+ * @title SearchToken
+ * @excerpt Search criteria for token-based filtering
+ */
 export type SearchToken = {
     values?: SearchTokenValue[];
     value?: SearchTokenValue;

package/dist/api/base/user/create-consent-request.d.ts

@@ -1,5 +1,11 @@
+import { CategoryCode, ConsentProvisionType, ConsentStatus } from "../../../models/enums/index.js";
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
-import { type CategoryCode, type ConsentProvisionType, type ConsentStatus } from "./types.js";
+/**
+ * Input type for creating user consents. Includes consent status, category, and provision details.
+ * @category Inputs
+ * @title CreateConsentRequestInput
+ * @excerpt Input for creating user consents with status and provisions
+ */
 export type CreateConsentRequestInput = {
     status: ConsentStatus;
     provision: ConsentProvisionType;
@@ -9,6 +15,12 @@ export type CreateConsentRequestInput = {
 export declare class CreateConsentRequestValidator implements Validator<CreateConsentRequestInput> {
     validate(data: CreateConsentRequestInput, errors: ErrorsCollector): void;
 }
+/**
+ * Request object for creating a consent.
+ * @category Requests
+ * @title CreateConsentRequest
+ * @excerpt Request object for creating a consent
+ */
 export declare class CreateConsentRequest extends ValidationRequest<CreateConsentRequestInput> {
     protected validator: Validator<CreateConsentRequestInput>;
 }

package/dist/api/base/user/create-consent-request.js

@@ -1,7 +1,6 @@
-import { CategoryCode as GraphQLCategoryCode } from "../../../graphql/schema.js";
 import { ValidationRequest, } from "../../../requests/index.js";
 import { isBlank, isUndefined } from "../../../utils/index.js";
-import { isValidCategoryCode, isValidConsentProvisionType, isValidConsentStatus, } from "./types.js";
+import { isValidCategoryCode, isValidConsentProvisionType, isValidConsentStatus, } from "./validators.js";
 export class CreateConsentRequestValidator {
     validate(data, errors) {
         if (!isValidConsentStatus(data.status)) {
@@ -18,12 +17,18 @@ export class CreateConsentRequestValidator {
             errors.add("organizationId cannot be empty");
         }
         // organizationId is required if category is PROA_ATTESTATION
-        if (data.category === GraphQLCategoryCode.ProaAttestation &&
+        if (data.category === "PROA_ATTESTATION" &&
             isUndefined(data.organizationId)) {
             errors.add("organizationId must be provided when category is PROA_ATTESTATION");
         }
     }
 }
+/**
+ * Request object for creating a consent.
+ * @category Requests
+ * @title CreateConsentRequest
+ * @excerpt Request object for creating a consent
+ */
 export class CreateConsentRequest extends ValidationRequest {
     constructor() {
         super(...arguments);

package/dist/api/base/user/create-verification-url-request.d.ts

@@ -1,7 +1,19 @@
 import { BaseRequest } from "../../../requests/index.js";
+/**
+ * Input type for creating a verification URL. Optionally includes callback URL and attribute matching settings.
+ * @category Inputs
+ * @title CreateVerificationUrlRequestInput
+ * @excerpt Input for creating verification URLs with optional settings
+ */
 export type CreateVerificationUrlRequestInput = {
     callbackUrl?: string;
     includeAttributeMatchingCheck?: boolean;
 };
+/**
+ * Request object for creating a verification URL.
+ * @category Requests
+ * @title CreateVerificationUrlRequest
+ * @excerpt Request object for creating a verification URL
+ */
 export declare class CreateVerificationUrlRequest extends BaseRequest<CreateVerificationUrlRequestInput> {
 }

package/dist/api/base/user/create-verification-url-request.js

@@ -1,3 +1,9 @@
 import { BaseRequest } from "../../../requests/index.js";
+/**
+ * Request object for creating a verification URL.
+ * @category Requests
+ * @title CreateVerificationUrlRequest
+ * @excerpt Request object for creating a verification URL
+ */
 export class CreateVerificationUrlRequest extends BaseRequest {
 }

package/dist/api/base/user/get-consents-request.d.ts

@@ -1,6 +1,12 @@
 import { CategoryCode as GraphQLCategoryCode } from "../../../graphql/schema.js";
+import { CategoryCode } from "../../../models/enums/index.js";
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
-import { CategoryCode } from "./types.js";
+/**
+ * Input type for getting user consents. Requires a category to filter consents by.
+ * @category Inputs
+ * @title GetConsentsRequestInput
+ * @excerpt Input for getting user consents by category
+ */
 export type GetConsentsRequestInput = {
     category: CategoryCode;
 };
@@ -10,6 +16,18 @@ export type GetConsentRequestData = {
 export declare class GetConsentsRequestValidator implements Validator<GetConsentsRequestInput> {
     validate(data: GetConsentsRequestInput, errors: ErrorsCollector): void;
 }
+/**
+ * Request object for fetching consents data.
+ * @category Requests
+ * @title GetConsentsRequest
+ * @excerpt Request object for fetching consents data
+ */
+/**
+ * Request object for fetching user consents.
+ * @category Requests
+ * @title GetConsentsRequest
+ * @excerpt Request object for fetching user consents
+ */
 export declare class GetConsentsRequest extends ValidationRequest<GetConsentsRequestInput> {
     protected validator: Validator<GetConsentsRequestInput>;
 }

package/dist/api/base/user/get-consents-request.js

@@ -1,5 +1,5 @@
 import { ValidationRequest, } from "../../../requests/index.js";
-import { isValidCategoryCode } from "./types.js";
+import { isValidCategoryCode } from "./validators.js";
 export class GetConsentsRequestValidator {
     validate(data, errors) {
         if (!isValidCategoryCode(data.category)) {
@@ -7,6 +7,18 @@ export class GetConsentsRequestValidator {
         }
     }
 }
+/**
+ * Request object for fetching consents data.
+ * @category Requests
+ * @title GetConsentsRequest
+ * @excerpt Request object for fetching consents data
+ */
+/**
+ * Request object for fetching user consents.
+ * @category Requests
+ * @title GetConsentsRequest
+ * @excerpt Request object for fetching user consents
+ */
 export class GetConsentsRequest extends ValidationRequest {
     constructor() {
         super(...arguments);

package/dist/api/base/user/index.d.ts

@@ -1,6 +1,5 @@
 export { UpdateProfileRequest, UpdateProfileRequestInput, } from "./update-profile-request.js";
 export { GetConsentsRequestInput, GetConsentsRequest, } from "./get-consents-request.js";
 export { CreateConsentRequest, CreateConsentRequestInput, } from "./create-consent-request.js";
-export type { CategoryCode, ConsentProvisionType, ConsentStatus, PersonGender, } from "./types.js";
-export { ProfileResults, DeleteUserResults, UpdateProfileResults, CreateConsentResults, UserManager, } from "./user-manager.js";
+export { UserManager } from "./user-manager.js";
 export { CreateVerificationUrlRequest, CreateVerificationUrlRequestInput, } from "./create-verification-url-request.js";

package/dist/api/base/user/update-profile-request.d.ts

@@ -1,5 +1,11 @@
+import { PersonGender } from "../../../models/enums/index.js";
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
-import { type PersonGender } from "./types.js";
+/**
+ * Input type for updating user profile information. All fields are optional for partial updates.
+ * @category Inputs
+ * @title UpdateProfileRequestInput
+ * @excerpt Input for updating user profile information
+ */
 export type UpdateProfileRequestInput = {
     id?: string;
     firstName?: string;
@@ -20,8 +26,10 @@ export declare class UpdateProfileRequestValidator implements Validator<UpdatePr
     validate(data: UpdateProfileRequestInput, errors: ErrorsCollector): void;
 }
 /**
- * A request class for passing along the new Profile Person information to the
- * updateUserProfile API Mutation
+ * Request object for updating user profile information.
+ * @category Requests
+ * @title UpdateProfileRequest
+ * @excerpt Request object for updating user profile information
  */
 export declare class UpdateProfileRequest extends ValidationRequest<UpdateProfileRequestInput> {
     protected validator: Validator<UpdateProfileRequestInput>;

package/dist/api/base/user/update-profile-request.js

@@ -1,6 +1,6 @@
 import { ValidationRequest, } from "../../../requests/index.js";
 import { isUndefined } from "../../../utils/index.js";
-import { isValidPersonGender } from "./types.js";
+import { isValidPersonGender } from "./validators.js";
 export class UpdateProfileRequestValidator {
     validate(data, errors) {
         if (!isUndefined(data.gender) && !isValidPersonGender(data.gender)) {
@@ -9,8 +9,10 @@ export class UpdateProfileRequestValidator {
     }
 }
 /**
- * A request class for passing along the new Profile Person information to the
- * updateUserProfile API Mutation
+ * Request object for updating user profile information.
+ * @category Requests
+ * @title UpdateProfileRequest
+ * @excerpt Request object for updating user profile information
  */
 export class UpdateProfileRequest extends ValidationRequest {
     constructor() {