@icanbwell/bwell-sdk-ts 1.54.0 → 1.55.0

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

@@ -1,50 +1,32 @@
-import { ValidationError } from "../../../errors/index.js";
-import { GetQuestionnaireResponsesQueryResults, GetQuestionnairesQueryResults, NextQuestionMutationResults, SaveQuestionnaireResponseMutationResults } from "../../../graphql/operations/types.js";
-import { BWellQueryResult, BWellTransactionResult } from "../../../results/index.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";
-import { NextQuestionRequest } from "./next-question-request.js";
-import { QuestionnaireResponsesRequest } from "./questionnaire-responses-request.js";
-import { QuestionnairesRequest } from "./questionnaires-request.js";
-import { SaveQuestionnaireResponseRequest } from "./save-questionnaire-response-request.js";
-export type NextQuestionResults = NextQuestionMutationResults["nextQuestion"];
-export type SaveQuestionnaireResponseResults = SaveQuestionnaireResponseMutationResults["saveQuestionnaireResponse"];
-export type QuestionnaireResponsesResults = GetQuestionnaireResponsesQueryResults["questionnaireResponses"];
-export type QuestionnairesResults = GetQuestionnairesQueryResults["questionnaires"];
 /**
- * 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(
+     *   new NextQuestionRequest({
+     *     questionnaireResponse: {
+     *       resourceType: 'QuestionnaireResponse',
+     *       status: 'in-progress',
+     *       questionnaire: 'health-assessment',
+     *       contained: []
+     *     }
+     *   })
+     * );
+     * ```
      */
-    nextQuestion(request: NextQuestionRequest): Promise<BWellTransactionResult<NextQuestionResults, BaseManagerError>>;
-    /**
-     * Saves a questionnaire response.
-     *
-     * @param request - The request object containing the questionnaire response data to save.
-     * @returns A promise that resolves to a `BWellTransactionResult` containing the saved questionnaire response
-     *          or an error of type `BaseManagerError`.
-     */
-    saveQuestionnaireResponse(request: SaveQuestionnaireResponseRequest): Promise<BWellTransactionResult<SaveQuestionnaireResponseResults, BaseManagerError>>;
-    /**
-     * Retrieves questionnaire responses based on the provided request parameters.
-     *
-     * @param request - The request object containing parameters for filtering questionnaire responses.
-     * @returns A promise that resolves to a `BWellQueryResult` containing the questionnaire responses
-     *          or an error of type `ValidationError` or `BaseManagerError`.
-     */
-    getQuestionnaireResponses(request?: QuestionnaireResponsesRequest): Promise<BWellQueryResult<QuestionnaireResponsesResults, ValidationError | BaseManagerError>>;
-    /**
-     * Retrieves questionnaires based on provided request parameters.
-     *
-     * @param request - The request object containing parameters for filtering questionnaires.
-     * @returns A promise that resolves to a `BWellQueryResult` containing the questionnaires
-     *          or an error of type `ValidationError` or `BaseManagerError`.
-     */
-    getQuestionnaires(request?: QuestionnairesRequest): Promise<BWellQueryResult<QuestionnairesResults, ValidationError | BaseManagerError>>;
+    nextQuestion(request: NextQuestionRequest): Promise<BWellTransactionResult<QuestionnaireResponse, BaseManagerError>>;
 }

package/dist/api/base/requests/field-sort-order.d.ts

@@ -0,0 +1,11 @@
+import { SortOrder } from "../../../models/index.js";
+/**
+ * Base sorting type used to sort by specific field type.
+ * @category Inputs
+ * @title FieldSortOrder
+ * @excerpt Used to define field order as ascending or descending
+ */
+export type FieldSortOrder<T = string> = {
+    field?: T;
+    order?: SortOrder;
+};

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

@@ -1,3 +1,5 @@
 export { SearchDate, SearchDateValue } from "./search-date.js";
 export { SearchString } from "./search-string.js";
 export { SearchToken, SearchTokenValue } from "./search-token.js";
+export { SearchReference } from "./search-reference.js";
+export type { FieldSortOrder } from "./field-sort-order.js";

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-reference.d.ts

@@ -1,5 +1,13 @@
-import { SearchReference } from "../../../graphql/schema.js";
 import { ErrorsCollector, Validator } from "../../../requests/index.js";
+/**
+ * Search criteria used to filter reference fields.
+ * @category Inputs
+ * @title SearchReference
+ * @excerpt Search criteria for reference fields
+ */
+export type SearchReference = {
+    value?: string;
+};
 /**
  * Error message for when reference value is empty
  */

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/requests/search-token.js

@@ -35,26 +35,26 @@ export class SearchTokenValidator {
         for (const value of (_a = data.values) !== null && _a !== void 0 ? _a : []) {
             __classPrivateFieldGet(this, _SearchTokenValidator_searchTokenValueValidator, "f").validate(value, errors);
         }
-        // Add validation for notEquals
-        if (data.notEquals !== undefined) {
-            // Validate notEquals values array if present
-            if (data.notEquals.values !== undefined) {
-                if (data.notEquals.values.length === 0) {
-                    errors.add("If notEquals values are provided, at least one Coding must be set");
-                    return;
-                }
-                for (const value of data.notEquals.values) {
-                    __classPrivateFieldGet(this, _SearchTokenValidator_searchTokenValueValidator, "f").validate(value, errors);
-                }
+        if (data.notEquals === undefined) {
+            return;
+        }
+        // Validate notEquals values array if present
+        if (data.notEquals.values !== undefined) {
+            if (data.notEquals.values.length === 0) {
+                errors.add("If notEquals values are provided, at least one Coding must be set");
+                return;
             }
-            // Ensure at least one property is set in notEquals
-            if (data.notEquals.code === undefined &&
-                data.notEquals.value === undefined &&
-                data.notEquals.system === undefined &&
-                data.notEquals.values === undefined) {
-                errors.add("NotEquals must have at least one non-null property (code, value, system, or values)");
+            for (const value of data.notEquals.values) {
+                __classPrivateFieldGet(this, _SearchTokenValidator_searchTokenValueValidator, "f").validate(value, errors);
             }
         }
+        // Ensure at least one property is set in notEquals
+        if (data.notEquals.code === undefined &&
+            data.notEquals.value === undefined &&
+            data.notEquals.system === undefined &&
+            data.notEquals.values === undefined) {
+            errors.add("NotEquals must have at least one non-null property (code, value, system, or values)");
+        }
     }
 }
 _SearchTokenValidator_searchTokenValueValidator = new WeakMap();

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

@@ -1,5 +1,3 @@
-export { SearchContextEnum } from "../../../graphql/schema.js";
-export type { SearchResults, RequestConnectionResults, SearchManager, SearchHealthResourcesResults, } from "./search-manager.js";
-export { SearchRequest, SearchRequestInput, FilterField, OrganizationType, OrderBy, SortOrder, SortField, SearchPosition, } from "./search-request.js";
-export { RequestConnectionRequestInput, RequestConnectionRequest, } from "./request-connection-request.js";
-export { SearchHealthResourcesRequest, SearchHealthResourcesRequestInput, } from "./search-health-resources-request.js";
+export type { SearchManager } from "./search-manager.js";
+export { SubmitProviderForReviewRequestInput, SubmitProviderForReviewRequest, } from "./submit-provider-for-review-request.js";
+export { SearchHealthResourcesRequest, SearchHealthResourcesRequestInput, SearchPosition, OrderBy, } from "./search-health-resources-request.js";

package/dist/api/base/search/index.js

@@ -1,4 +1,2 @@
-export { SearchContextEnum } from "../../../graphql/schema.js";
-export { SearchRequest, } from "./search-request.js";
-export { RequestConnectionRequest, } from "./request-connection-request.js";
+export { SubmitProviderForReviewRequest, } from "./submit-provider-for-review-request.js";
 export { SearchHealthResourcesRequest, } from "./search-health-resources-request.js";

package/dist/api/base/search/search-health-resources-request.d.ts

@@ -1,25 +1,12 @@
-import { ClientInput, FilterField as GraphQLFilterField, OrganizationType as GraphQLOrganizationType, SortField as GraphQLSortField, SortOrder as GraphQLSortOrder, OrderByInput, SearchFiltersInput, SearchLocation, UserInput } from "../../../graphql/schema.js";
+import { OrderByInput, SearchFiltersInput, SearchLocation, UserInput } from "../../../graphql/schema.js";
+import { DataSet, SearchContext, SortField } from "../../../models/enums/index.js";
 import { PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
-import { SearchContextEnum } from "./index.js";
-/**
- * Type representing the search filters for health resources.
- */
-export type FilterField = `${GraphQLFilterField}`;
-/**
- * Type representing the organization type for health resources.
- */
-export type OrganizationType = `${GraphQLOrganizationType}`;
-/**
- * Type representing the sort field for health resources.
- * @experimental
- */
-export type SortField = `${GraphQLSortField}`;
-/**
- * Type representing the sort order for health resources.
- */
-export type SortOrder = `${GraphQLSortOrder}`;
+import { FieldSortOrder } from "../index.js";
 /**
  * The provider location to search by
+ * @category Inputs
+ * @title SearchPosition
+ * @excerpt Position coordinates for location-based searches
  */
 export type SearchPosition = {
     /**
@@ -37,30 +24,38 @@ export type SearchPosition = {
 };
 /**
  * Type representing a provider search result sorting
+ * @category Inputs
+ * @title OrderBy
+ * @excerpt Sorting configuration for search results
  */
-export type OrderBy = {
-    /**
-     * The provider search field to sort by
-     */
-    field?: SortField;
-    /**
-     * The direction to sort by
-     */
-    order?: SortOrder;
+export type OrderBy = FieldSortOrder<SortField>;
+/**
+ * Client configuration to use for this call to filter data.
+ * @deprecated Internal bwell use only
+ * @category Inputs
+ * @title SearchHealthResourcesClientInput
+ * @excerpt Client configuration for searching health resources
+ */
+export type SearchHealthResourcesClientInput = {
+    config?: string;
+    dataSets?: DataSet[];
 };
 /**
  * Represents the parameters for a search request.
  * @experimental
+ * @category Inputs
+ * @title SearchHealthResourcesRequestInput
+ * @excerpt Input parameters for searching health resources
  */
 export type SearchHealthResourcesRequestInput = PagedRequestInput & {
     /**
-     * The client configuration to search for health resources.
+     * @deprecated Internal bwell use only
      */
-    client?: [ClientInput];
+    client?: SearchHealthResourcesClientInput[];
     /**
      * The filters to apply to the search.
      */
-    filters: SearchFiltersInput;
+    filters?: SearchFiltersInput;
     /**
      * Specifies order options for the search.
      */
@@ -70,6 +65,10 @@ export type SearchHealthResourcesRequestInput = PagedRequestInput & {
      * This can be something like an organization name, location, address, or phone number.
      */
     search?: string;
+    /**
+     * Context to be used for search.
+     */
+    searchContext?: SearchContext;
     /**
      * The location to search health resources by.
      */
@@ -78,15 +77,13 @@ export type SearchHealthResourcesRequestInput = PagedRequestInput & {
      * The user for whom the search is being performed.
      */
     user?: UserInput;
-    /**
-     * Defines the context in which a search is being performed, which determines
-     * which configurations are applied to the search results.
-     */
-    searchContext?: SearchContextEnum;
 };
 /**
  * Request for searching health resources.
  * @experimental
+ * @category Requests
+ * @title SearchHealthResourcesRequest
+ * @excerpt Request class for searching health resources
  */
 export declare class SearchHealthResourcesRequest extends PagedRequest<SearchHealthResourcesRequestInput> {
     protected validator: PagedRequestValidator<SearchHealthResourcesRequestInput>;

package/dist/api/base/search/search-health-resources-request.js

@@ -2,6 +2,9 @@ import { PagedRequest, PagedRequestValidator, } from "../../../requests/index.js
 /**
  * Request for searching health resources.
  * @experimental
+ * @category Requests
+ * @title SearchHealthResourcesRequest
+ * @excerpt Request class for searching health resources
  */
 export class SearchHealthResourcesRequest extends PagedRequest {
     constructor() {

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

@@ -1,58 +1,55 @@
 import { ValidationError } from "../../../errors/index.js";
-import { ProviderSearchQueryResults, RequestConnectionMutationResults, SearchHealthResourcesQueryResults } from "../../../graphql/operations/types.js";
+import { HealthResourcesBundle, ProviderReviewResult } from "../../../models/index.js";
 import type { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
 import { BaseManagerError } from "../errors.js";
-import { RequestConnectionRequest } from "./request-connection-request.js";
 import { SearchHealthResourcesRequest } from "./search-health-resources-request.js";
-import { SearchRequest } from "./search-request.js";
-type SearchResultsType = ProviderSearchQueryResults["providers"];
-export interface SearchResults extends SearchResultsType {
-}
-export type SearchHealthResourcesResults = SearchHealthResourcesQueryResults["searchHealthResources"];
-export type RequestConnectionResults = RequestConnectionMutationResults["requestConnection"];
+import { SubmitProviderForReviewRequest } from "./submit-provider-for-review-request.js";
 /**
- * The SearchManager interface provides methods for searching for providers and connections.
+ * Search Manager for healthcare provider and resource discovery.
+ * Provides methods for searching health resources and submitting providers for review.
+ *
+ * @title SearchManager
+ * @excerpt Search Manager for healthcare provider and resource discovery
+ * @category Managers
  */
 export interface SearchManager {
-    /**
-     * Performs a general search based on a SearchRequest
-     *
-     * @param {SearchRequest} request - Object representing search parameters
-     * @returns {Promise<BWellQueryResult<SearchResults, BaseManagerError | ValidationError>>} - An object containing the collection
-     * of matching search results
-     */
-    search(request: SearchRequest): Promise<BWellQueryResult<SearchResults, BaseManagerError | ValidationError>>;
-    /**
-     * Performs a provider search based on a SearchRequest
-     *
-     * @param {SearchRequest} request - Object representing search parameters
-     * @returns {Promise<BWellQueryResult<SearchResults, BaseManagerError | ValidationError>>} - An object containing the collection
-     * of matching search results
-     */
-    searchProviders(request: SearchRequest): Promise<BWellQueryResult<SearchResults, BaseManagerError | ValidationError>>;
-    /**
-     * Performs a connection search based on a SearchRequest
-     *
-     * @param {SearchRequest} request - Object representing search parameters
-     * @returns {Promise<BWellQueryResult<SearchResults, BaseManagerError | ValidationError>>} - An object containing the collection
-     * of matching search results
-     */
-    searchConnections(request: SearchRequest): Promise<BWellQueryResult<SearchResults, BaseManagerError | ValidationError>>;
     /**
      * Searches for health resources based on the provided request.
+     * Finds healthcare providers, facilities, and other health-related resources.
      *
-     * @param {SearchHealthResourcesRequest} request - Object containing the details of the search being requested
-     * @returns {Promise<BWellQueryResult<SearchHealthResourcesResults, BaseManagerError | ValidationError>>} - An object containing the collection
-     * of matching search results
+     * @param {SearchHealthResourcesRequest} request - SearchHealthResourcesRequest instance containing the details of the search being requested
+     * @returns {Promise<BWellQueryResult<HealthResourcesBundle, BaseManagerError | ValidationError>>} - An object containing the collection of matching search results
      * @experimental
+     * @example
+     * ```typescript
+     * const results = await sdk.search.searchHealthResources(
+     *   new SearchHealthResourcesRequest({
+     *     search: 'cardiologist',
+     *     searchLocation: { zipCode: '10001' }
+     *   })
+     * );
+     * ```
      */
-    searchHealthResources(request: SearchHealthResourcesRequest): Promise<BWellQueryResult<SearchHealthResourcesResults, BaseManagerError | ValidationError>>;
+    searchHealthResources(request: SearchHealthResourcesRequest): Promise<BWellQueryResult<HealthResourcesBundle, BaseManagerError | ValidationError>>;
     /**
-     * Requests a new connection based on the provided information.
+     * Submits a provider for review to be added as a new healthcare provider or facility to the directory.
+     * The request undergoes an administrative approval process before inclusion.
+     *
+     * Users can provide details such as institution, provider name, state, and city to facilitate review and potential addition of the healthcare resource.
      *
-     * @param {RequestConnectionRequest} request - Object containing the details of the connection being requested
-     * @returns {Promise<BWellTransactionResult<RequestConnectionResults, BaseManagerError>>} - Indicates the outcome of the request
+     * @param {SubmitProviderForReviewRequest} request - Request class instance containing details of the provider or facility to be added
+     * @returns {Promise<BWellTransactionResult<ProviderReviewResult, BaseManagerError>>} - Outcome of the submission and approval process
+     * @example
+     * ```typescript
+     * await sdk.search.submitProviderForReview(
+     *   new SubmitProviderForReviewRequest({
+     *     provider: 'Dr. Jane Smith',
+     *     institution: 'City Medical Center',
+     *     city: 'Boston',
+     *     state: 'MA'
+     *   })
+     * );
+     * ```
      */
-    requestConnection(request: RequestConnectionRequest): Promise<BWellTransactionResult<RequestConnectionResults, BaseManagerError>>;
+    submitProviderForReview(request: SubmitProviderForReviewRequest): Promise<BWellTransactionResult<ProviderReviewResult, BaseManagerError>>;
 }
-export {};

package/dist/api/base/search/submit-provider-for-review-request.d.ts

@@ -0,0 +1,33 @@
+import { BaseRequest } from "../../../requests/index.js";
+/**
+ * Parameters for submitting a provider or facility request
+ * @category Inputs
+ * @title SubmitProviderForReviewRequestInput
+ * @excerpt Input parameters for submitting a provider or facility for review
+ */
+export type SubmitProviderForReviewRequestInput = {
+    /**
+     * Institution of the provider or facility
+     */
+    institution?: string;
+    /**
+     * Provider name
+     */
+    provider?: string;
+    /**
+     * State where the provider or facility is located
+     */
+    state?: string;
+    /**
+     * City where the provider or facility is located
+     */
+    city?: string;
+};
+/**
+ * Request class for submitting a provider or facility for review.
+ * @category Requests
+ * @title SubmitProviderForReviewRequest
+ * @excerpt Request for submitting a provider or facility for review
+ */
+export declare class SubmitProviderForReviewRequest extends BaseRequest<SubmitProviderForReviewRequestInput> {
+}

package/dist/api/base/search/submit-provider-for-review-request.js

@@ -0,0 +1,9 @@
+import { BaseRequest } from "../../../requests/index.js";
+/**
+ * Request class for submitting a provider or facility for review.
+ * @category Requests
+ * @title SubmitProviderForReviewRequest
+ * @excerpt Request for submitting a provider or facility for review
+ */
+export class SubmitProviderForReviewRequest extends BaseRequest {
+}

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)) {
@@ -17,13 +16,19 @@ export class CreateConsentRequestValidator {
         if (!isUndefined(data.organizationId) && isBlank(data.organizationId)) {
             errors.add("organizationId cannot be empty");
         }
-        // organizationId is required if category is PROA_ATTESTATION
-        if (data.category === GraphQLCategoryCode.ProaAttestation &&
+        // organizationId is required if category is proaAttestation
+        if (data.category === "proaAttestation" &&
             isUndefined(data.organizationId)) {
-            errors.add("organizationId must be provided when category is PROA_ATTESTATION");
+            errors.add("organizationId must be provided when category is proaAttestation");
         }
     }
 }
+/**
+ * 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-data-export-direct-download-url-request.d.ts

@@ -1,4 +1,10 @@
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
+/**
+ * Input type for creating a direct download URL for a data export. Requires export ID and password for secure access.
+ * @category Inputs
+ * @title CreateDataExportDirectDownloadUrlRequestInput
+ * @excerpt Input for creating data export direct download URLs
+ */
 export type CreateDataExportDirectDownloadUrlRequestInput = {
     exportId: string;
     password: string;
@@ -8,6 +14,9 @@ export declare class CreateDataExportDirectDownloadUrlRequestValidator implement
 }
 /**
  * Request object for creating a direct download URL for a data export.
+ * @category Requests
+ * @title CreateDataExportDirectDownloadUrlRequest
+ * @excerpt Request object for creating a direct download URL for a data export
  */
 export declare class CreateDataExportDirectDownloadUrlRequest extends ValidationRequest<CreateDataExportDirectDownloadUrlRequestInput> {
     protected validator: Validator<CreateDataExportDirectDownloadUrlRequestInput>;

package/dist/api/base/user/create-data-export-direct-download-url-request.js

@@ -12,6 +12,9 @@ export class CreateDataExportDirectDownloadUrlRequestValidator {
 }
 /**
  * Request object for creating a direct download URL for a data export.
+ * @category Requests
+ * @title CreateDataExportDirectDownloadUrlRequest
+ * @excerpt Request object for creating a direct download URL for a data export
  */
 export class CreateDataExportDirectDownloadUrlRequest extends ValidationRequest {
     constructor() {

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 {
 }