@icanbwell/bwell-sdk-ts 1.55.0 → 1.56.0

package/README.md

@@ -9,8 +9,8 @@ providers or connections. Please see the documentation for details.
 
 ## SDKv2 / SDKv1 Update
 
-The `main` branch will soon be updated to be for SDKv2 only. Any v1 updates are
-to be made to `typescript-sdk-v1` branch once that happens.
+The `main` has been updated to be for TS SDKv2 only. Any v1 updates should be
+made to `typescript-sdk-v1` branch.
 
 ## Installation
 
@@ -25,6 +25,7 @@ import { BWellSDK }
 
 const sdk = new BWellSDK({
   clientKey: "YOUR_CLIENT_KEY",
+  clientSecret: "YOUR_CLIENT_SECRET",
 });
 
 await sdk.initialize();
@@ -37,20 +38,3 @@ const healthSummaryResponse = sdk.health.getHealthSummary();
 
 const healthSummaryData = healthSummaryResponse.data;
 ```
-
-## Documentation
-
-For detailed documentation on generating external documentation sites
-(HTML/Markdown):
-
-📚 **[TypeDoc Documentation Guide]**
-
-Quick commands:
-
-```bash
-# Generate HTML documentation
-npm run generate:docs:html
-
-# Generate Readme documentation
-npm run generate:docs:readme
-```

package/dist/__version__.d.ts

@@ -1,4 +1,4 @@
 /**
  * This file is automatically generated. Please do not edit this file directly.
  */
-export declare const VERSION = "1.55.0";
+export declare const VERSION = "1.56.0";

package/dist/__version__.js

@@ -1,4 +1,4 @@
 /**
  * This file is automatically generated. Please do not edit this file directly.
  */
-export const VERSION = "1.55.0";
+export const VERSION = "1.56.0";

package/dist/api/api-provider-factory.d.ts

@@ -3,5 +3,5 @@ import { LoggerProvider } from "../logger/index.js";
 import { TokenManager } from "../tokens/index.js";
 import { ApiProvider } from "./base/api-provider.js";
 export declare class ApiProviderFactory {
-    createApiProvider(config: SdkConfig, loggerProvider: LoggerProvider, tokenManager?: TokenManager): ApiProvider;
+    createApiProvider(config: SdkConfig, tokenManager: TokenManager, loggerProvider: LoggerProvider): ApiProvider;
 }

package/dist/api/api-provider-factory.js

@@ -1,8 +1,7 @@
 import { graphQLSDKFactory } from "./graphql-api/graphql-sdk/index.js";
 import { GraphQLApiProvider } from "./graphql-api/index.js";
 export class ApiProviderFactory {
-    createApiProvider(config, loggerProvider, tokenManager) {
-        // TODO: PHR-1137 - Handle optional params better
+    createApiProvider(config, tokenManager, loggerProvider) {
         const { sdk, client } = graphQLSDKFactory(config.graphQL.apiUrl, tokenManager, config.bwellConfig.language);
         return new GraphQLApiProvider(sdk, loggerProvider, client);
     }

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

@@ -1,28 +1,35 @@
-import { TaskResponse } from "../../../models/index.js";
-import { BWellQueryResult } from "../../../results/index.js";
+import { ValidationError } from "../../../errors/index.js";
+import { GetTasksQueryResults, TaskUpdateStatusMutationResults } from "../../../graphql/operations/types.js";
+import type { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
 import { BaseManagerError } from "../errors.js";
 import { GetTasksRequest } from "./get-tasks-request.js";
+import { UpdateTaskStatusRequest } from "./update-task-status-request.js";
+export type GetTasksResults = GetTasksQueryResults["getTasks"];
+export type UpdateTaskStatusResults = TaskUpdateStatusMutationResults["taskUpdateStatus"];
 /**
- * Activity Manager for managing tasks and activities.
- * Provides methods for retrieving and managing Task resources.
- * @title ActivityManager
- * @excerpt Activity Manager for managing tasks and activities
- * @category Managers
+ * The ActivityManager interface provides methods for managing FHIR tasks.
+ * See also https://www.hl7.org/fhir/task.html
  */
 export interface ActivityManager {
     /**
-     * Retrieves a list of Task resources.
+     * Tasks represent insights, recommendations, and/or requests for the user. They
+     * can be personalized and have a status to track progress. Tasks can also be linked
+     * to other FHIR resources and/or external content.
      *
-     * By default, system tasks are excluded from results; this behavior
-     * is overridden if a performer filter is explicitly provided in the
-     * GetTasksRequest.
+     * @param {GetTasksRequest} request - The query search criteria
+     * @returns {Promise<BWellQueryResult<GetTasksResults, BaseManagerError>>} Collection of FHIR Task resources
+     */
+    getTasks(request: GetTasksRequest): Promise<BWellQueryResult<GetTasksResults, BaseManagerError | ValidationError>>;
+    /**
+     * Updates the status of a specified Task. The status of the task identified
+     * by request.taskId will be updated to the new status provided.
+     *
+     * The new status must be one of the potential TaskStatus values
+     *
+     * @param {UpdateTaskStatusRequest} request - Object containing the id and desired status for the task
+     * @returns {Promise<BWellTransactionResult<UpdateTaskStatusResults, BaseManagerError>>} - Object containing the updated FHIR task resource
      *
-     * @param {GetTasksRequest} request The request object containing parameters for retrieving tasks.
-     * @returns {Promise<BWellQueryResult<TaskResponse, BaseManagerError>>} A promise resolving to an object representing the list of Task resources retrieved.
-     * @example
-     * ```typescript
-     * const tasks = await sdk.activity.getTasks();
-     * ```
+     * @see https://build.fhir.org/valueset-task-status.html
      */
-    getTasks(request: GetTasksRequest): Promise<BWellQueryResult<TaskResponse, BaseManagerError>>;
+    updateTaskStatus(request: UpdateTaskStatusRequest): Promise<BWellTransactionResult<UpdateTaskStatusResults, BaseManagerError | ValidationError>>;
 }

package/dist/api/base/activity/get-tasks-request.d.ts

@@ -1,34 +1,54 @@
 import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
-import { SearchReference, SearchString, SearchToken } from "../requests/index.js";
-/**
- * Input type for Task requests.
- * @category Inputs
- * @title GetTasksRequestInput
- * @excerpt Input for Task query with filters and pagination
- */
-export type GetTasksRequestInput = PagedRequestInput & {
-    id?: SearchString;
-    identifier?: SearchToken;
-    code?: SearchToken;
-    tag?: SearchToken;
-    status?: SearchToken;
-    performer?: SearchToken;
-    subject?: SearchReference;
+import { TaskStatus } from "./types.js";
+export type GetTaskRequestInput = PagedRequestInput & {
+    /**
+     * The id[s] of a tasks to search for
+     */
+    id?: string | string[];
+    /**
+     * The activityId[s] of tasks to filter by
+     */
+    activityId?: string | string[];
+    /**
+     * The activityType[s] of tasks to filter by
+     */
+    activityType?: string | string[];
+    /**
+     * The activityTopic[s] of tasks to filter by
+     */
+    activityTopic?: string | string[];
+    /**
+     * The status[es] of tasks to fitler by
+     */
+    status?: TaskStatus | TaskStatus[];
+    /**
+     * subject[s] of tasks to filter by
+     */
+    subject?: string | string[];
+    /**
+     * If provided, results will be filtered down to Tasks that have performers
+     * matching the specified types (e.g., "system", "user").
+     */
+    performerType?: string | string[];
+    /**
+     * If present and true, retrieve referenced content from CMS. All content found
+     * will be added to the associated Task field "extension"
+     */
+    enrichContent?: boolean;
+    /**
+     * If present and true, results will be ordered to place better Tasks for user
+     * consumption at the front of the list. Otherwise, Tasks will be unordered.
+     */
+    smartSort?: boolean;
+    /**
+     * The preferred language for returned content, e.g. "en" for English, "es" for Spanish
+     */
+    contentLanguage?: string;
 };
-/**
- * Validator for GetTasks request inputs.
- */
-declare class GetTasksRequestValidator extends PagedRequestValidator<GetTasksRequestInput> {
+export declare class GetTasksRequestValidator extends PagedRequestValidator<GetTaskRequestInput> {
     #private;
-    validate(data: GetTasksRequestInput, errors: ErrorsCollector): void;
+    validate(data: GetTaskRequestInput, errors: ErrorsCollector): void;
 }
-/**
- * Request object for fetching Task resources.
- * @category Requests
- * @title GetTasksRequest
- * @excerpt Request object for fetching Task FHIR resources with validation
- */
-export declare class GetTasksRequest extends PagedRequest<GetTasksRequestInput> {
-    protected validator: GetTasksRequestValidator;
+export declare class GetTasksRequest extends PagedRequest<GetTaskRequestInput> {
+    protected validator: PagedRequestValidator<GetTaskRequestInput>;
 }
-export {};

package/dist/api/base/activity/get-tasks-request.js

@@ -3,57 +3,30 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _GetTasksRequestValidator_searchStringValidator, _GetTasksRequestValidator_searchReferenceValidator, _GetTasksRequestValidator_searchTokenValidator;
+var _GetTasksRequestValidator_instances, _GetTasksRequestValidator_validateTaskStatus;
 import { PagedRequest, PagedRequestValidator, } from "../../../requests/index.js";
-import { isNotNullOrUndefined } from "../../../utils/type-utils.js";
-import { SearchReferenceValidator } from "../requests/search-reference.js";
-import { SearchStringValidator } from "../requests/search-string.js";
-import { SearchTokenValidator } from "../requests/search-token.js";
-/**
- * Validator for GetTasks request inputs.
- */
-class GetTasksRequestValidator extends PagedRequestValidator {
+import { isUndefined } from "../../../utils/index.js";
+import { isValidTaskStatus } from "./types.js";
+export class GetTasksRequestValidator extends PagedRequestValidator {
     constructor() {
         super(...arguments);
-        _GetTasksRequestValidator_searchStringValidator.set(this, new SearchStringValidator());
-        _GetTasksRequestValidator_searchReferenceValidator.set(this, new SearchReferenceValidator());
-        _GetTasksRequestValidator_searchTokenValidator.set(this, new SearchTokenValidator());
+        _GetTasksRequestValidator_instances.add(this);
     }
     validate(data, errors) {
         super.validate(data, errors);
-        // Validate SearchString fields
-        if (isNotNullOrUndefined(data.id)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchStringValidator, "f").validate(data.id, errors);
-        }
-        // Validate SearchToken fields
-        if (isNotNullOrUndefined(data.code)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchTokenValidator, "f").validate(data.code, errors);
-        }
-        if (isNotNullOrUndefined(data.tag)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchTokenValidator, "f").validate(data.tag, errors);
-        }
-        if (isNotNullOrUndefined(data.status)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchTokenValidator, "f").validate(data.status, errors);
-        }
-        if (isNotNullOrUndefined(data.performer)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchTokenValidator, "f").validate(data.performer, errors);
-        }
-        if (isNotNullOrUndefined(data.identifier)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchTokenValidator, "f").validate(data.identifier, errors);
-        }
-        // Validate SearchReference fields
-        if (isNotNullOrUndefined(data.subject)) {
-            __classPrivateFieldGet(this, _GetTasksRequestValidator_searchReferenceValidator, "f").validate(data.subject, errors);
+        if (!isUndefined(data.status)) {
+            const statuses = Array.isArray(data.status) ? data.status : [data.status];
+            for (const status of statuses) {
+                __classPrivateFieldGet(this, _GetTasksRequestValidator_instances, "m", _GetTasksRequestValidator_validateTaskStatus).call(this, status, errors);
+            }
         }
     }
 }
-_GetTasksRequestValidator_searchStringValidator = new WeakMap(), _GetTasksRequestValidator_searchReferenceValidator = new WeakMap(), _GetTasksRequestValidator_searchTokenValidator = new WeakMap();
-/**
- * Request object for fetching Task resources.
- * @category Requests
- * @title GetTasksRequest
- * @excerpt Request object for fetching Task FHIR resources with validation
- */
+_GetTasksRequestValidator_instances = new WeakSet(), _GetTasksRequestValidator_validateTaskStatus = function _GetTasksRequestValidator_validateTaskStatus(status, errors) {
+    if (!isValidTaskStatus(status)) {
+        errors.add(`Invalid task status: "${status}"`);
+    }
+};
 export class GetTasksRequest extends PagedRequest {
     constructor() {
         super(...arguments);

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

@@ -1,2 +1,4 @@
-export { ActivityManager } from "./activity-manager.js";
-export { GetTasksRequest, GetTasksRequestInput } from "./get-tasks-request.js";
+export { GetTasksResults, UpdateTaskStatusResults, ActivityManager, } from "./activity-manager.js";
+export { GetTasksRequest, GetTaskRequestInput } from "./get-tasks-request.js";
+export { UpdateTaskStatusRequest, UpdateTaskStatusRequestInput, } from "./update-task-status-request.js";
+export { TaskStatus } from "./types.js";

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

@@ -1 +1,2 @@
 export { GetTasksRequest } from "./get-tasks-request.js";
+export { UpdateTaskStatusRequest, } from "./update-task-status-request.js";

package/dist/api/base/activity/types.d.ts

@@ -0,0 +1,3 @@
+import { TaskStatus as GraphQLTaskStatus } from "../../../graphql/schema.js";
+export type TaskStatus = `${GraphQLTaskStatus}`;
+export declare function isValidTaskStatus(status: string): status is GraphQLTaskStatus;

package/dist/api/base/activity/types.js

@@ -0,0 +1,5 @@
+import { TaskStatus as GraphQLTaskStatus } from "../../../graphql/schema.js";
+const taskStatusCache = new Set(Object.values(GraphQLTaskStatus));
+export function isValidTaskStatus(status) {
+    return taskStatusCache.has(status);
+}

package/dist/api/base/activity/update-task-status-request.d.ts

@@ -0,0 +1,18 @@
+import { TaskStatus as GraphQLTaskStatus } from "../../../graphql/schema.js";
+import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
+import { TaskStatus } from "./types.js";
+export type UpdateTaskStatusRequestInput = {
+    taskId: string;
+    newStatus: TaskStatus;
+};
+type UpdateTaskStatusRequestData = {
+    taskId: string;
+    newStatus: GraphQLTaskStatus;
+};
+export declare class UpdateTaskStatusRequestValidator implements Validator<UpdateTaskStatusRequestInput> {
+    validate(data: UpdateTaskStatusRequestInput, errors: ErrorsCollector): void;
+}
+export declare class UpdateTaskStatusRequest extends ValidationRequest<UpdateTaskStatusRequestInput, UpdateTaskStatusRequestData> {
+    protected validator: Validator<UpdateTaskStatusRequestInput>;
+}
+export {};

package/dist/api/base/activity/update-task-status-request.js

@@ -0,0 +1,15 @@
+import { ValidationRequest, } from "../../../requests/index.js";
+import { isValidTaskStatus } from "./types.js";
+export class UpdateTaskStatusRequestValidator {
+    validate(data, errors) {
+        if (!isValidTaskStatus(data.newStatus)) {
+            errors.add(`Invalid task status: "${data.newStatus}"`);
+        }
+    }
+}
+export class UpdateTaskStatusRequest extends ValidationRequest {
+    constructor() {
+        super(...arguments);
+        this.validator = new UpdateTaskStatusRequestValidator();
+    }
+}

package/dist/api/base/api-provider.d.ts

@@ -1,14 +1,15 @@
 import type { LanguageManager } from "../../language/language-manager.js";
-import { ActivityManager } from "./activity/index.js";
-import { ConnectionManager } from "./connection/index.js";
-import { DeviceManager } from "./device/index.js";
-import { FinancialManager } from "./financial/index.js";
-import { HealthManager } from "./health-data/index.js";
-import { HealthSpaceManager } from "./health-space/index.js";
-import { IdentityManager } from "./identity/identity-manager.js";
-import { QuestionnaireManager } from "./questionnaire/index.js";
-import { SearchManager } from "./search/search-manager.js";
-import { UserManager } from "./user/index.js";
+import type { ActivityManager } from "./activity/activity-manager.js";
+import type { ConnectionManager } from "./connection/connection-manager.js";
+import type { DeviceManager } from "./device/device-manager.js";
+import type { EventManager } from "./event/event-manager.js";
+import type { FinancialManager } from "./financial/financial-manager.js";
+import type { HealthManager } from "./health-data/health-manager.js";
+import type { HealthSpaceManager } from "./health-space/health-space-manager.js";
+import type { QuestionnaireManager } from "./questionnaire/questionnaire-manager.js";
+import type { SearchManager } from "./search/search-manager.js";
+import type { SupportManager } from "./support/support-manager.js";
+import type { UserManager } from "./user/user-manager.js";
 export interface ApiProvider {
     readonly health: HealthManager;
     readonly financial: FinancialManager;
@@ -17,8 +18,9 @@ export interface ApiProvider {
     readonly device: DeviceManager;
     readonly connection: ConnectionManager;
     readonly activity: ActivityManager;
+    readonly event: EventManager;
     readonly search: SearchManager;
-    readonly questionnaire: QuestionnaireManager;
     readonly language: LanguageManager;
-    readonly identity: IdentityManager;
+    readonly questionnaire: QuestionnaireManager;
+    readonly support: SupportManager;
 }

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

@@ -1,91 +1,74 @@
-import type { Connection, ConnectionStatus, DataSource, MemberConnection, OAuthUrl } from "../../../models/index.js";
+import { CreateConnectionMutationResults, DeleteConnectionMutationResults, DisconnectConnectionMutationResults, GetDataSourceQueryResults, GetOauthUrlQueryResults } from "../../../graphql/operations/types.js";
 import type { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
+import { MemberConnectionResults } from "../../graphql-api/connection/index.js";
 import type { BaseManagerError } from "../errors.js";
 import { ConnectionRequest, DataSourceRequest } from "./connection-request.js";
-/**
- * @private
- */
 export declare const MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID = "data-connection-status";
+type DataSourceResultsType = GetDataSourceQueryResults["getDataSource"];
+export interface DataSourceResults extends DataSourceResultsType {
+}
+type CreateConnectionResultsType = CreateConnectionMutationResults["createConnection"];
+export interface CreateConnectionResults extends CreateConnectionResultsType {
+}
+type DisconnectConnectionResultsType = DisconnectConnectionMutationResults["disconnectConnection"];
+export interface DisconnectConnectionResults extends DisconnectConnectionResultsType {
+}
+type DeleteConnectionResultsType = DeleteConnectionMutationResults["deleteConnection"];
+export interface DeleteConnectionResults extends DeleteConnectionResultsType {
+}
+type OauthUrlResultsType = GetOauthUrlQueryResults["getOauthUrl"];
+export interface OauthUrlResults extends OauthUrlResultsType {
+}
 /**
- * Connection Manager for data source connections and OAuth management.
- * Provides methods for managing connections to healthcare providers and data sources.
- * @title ConnectionManager
- * @excerpt Connection Manager for data source connections and OAuth management
- * @category Managers
+ * The ConnectionManager interface provides methods for managing connections to data sources/healthcare providers.
  */
 export interface ConnectionManager {
     /**
      * Retrieves a list of MemberConnections resources from a FHIR server.
      * There are no parameters and no request object for this method.
      *
-     * @returns {Promise<BWellQueryResult<MemberConnection[]>>} A promise resolving to an object representing the list of MemberConnections resources retrieved, along with potential validation or GraphQL errors.
+     * @returns {Promise<BWellQueryResult<MemberConnectionResults>>} A promise resolving to an object representing the list of MemberConnections resources retrieved, along with potential validation or GraphQL errors.
      */
-    getMemberConnections(): Promise<BWellQueryResult<MemberConnection[], BaseManagerError>>;
+    getMemberConnections(): Promise<BWellQueryResult<MemberConnectionResults, BaseManagerError>>;
     /**
-     * Retrieves a data source by ID.
-     * Gets information about a specific healthcare provider connection.
-     * @example
-     * ```typescript
-     * const dataSource = await sdk.connection.getDataSource(
-     *   new DataSourceRequest({
-     *     connectionId: 'epic-123'
-     *   })
-     * );
-     * ```
+     * Retrieves a DataSource by id.
+     *
+     * @param {DataSourceRequest<DataSourceRequestInput>} request The request object containing the connectionId of the DataSource to retrieve.
+     *
+     * @returns {Promise<BWellQueryResult<DataSourceResults>>} A promise resolving to an object representing the list of DataSource resources retrieved, along with potential validation or GraphQL errors.
      */
-    getDataSource(request: DataSourceRequest): Promise<BWellQueryResult<DataSource, BaseManagerError>>;
+    getDataSource(request: DataSourceRequest): Promise<BWellQueryResult<DataSourceResults, BaseManagerError>>;
     /**
-     * Creates a new connection to a healthcare provider.
-     * Establishes a connection to retrieve health data.
-     * @example
-     * ```typescript
-     * await sdk.connection.createConnection(
-     *   new ConnectionRequest({
-     *     connectionId: 'epic-123',
-     *     username: 'user',
-     *     password: 'pass'
-     *   })
-     * );
-     * ```
+     * Creates a new Connection resource.
+     *
+     * @param {ConnectionRequest} request The request object containing the connectionId of the DataSource to create.
+     *
+     * @returns {Promise<BWellTransactionResult<CreateConnectionResults>>} A promise resolving to an object representing the list of Connection resources created, along with potential validation or GraphQL errors.
      */
-    createConnection(request: ConnectionRequest): Promise<BWellTransactionResult<Connection, BaseManagerError>>;
+    createConnection(request: ConnectionRequest): Promise<BWellTransactionResult<CreateConnectionResults, BaseManagerError>>;
     /**
-     * Disconnects an existing connection.
-     * Stops data synchronization but preserves existing data.
-     * @example
-     * ```typescript
-     * await sdk.connection.disconnectConnection(
-     *   new DataSourceRequest({
-     *     connectionId: 'epic-123'
-     *   })
-     * );
-     * ```
+     * Disconnects a Connection resource.
+     *
+     * @param {ConnectionRequest} request The request object containing the connectionId of the DataSource to disconnect.
+     *
+     * @returns {Promise<BWellTransactionResult<DisconnectConnectionResults>>} A promise resolving to an object representing the list of Connection resources disconnected, along with potential validation or GraphQL errors.
      */
-    disconnectConnection(request: DataSourceRequest): Promise<BWellTransactionResult<ConnectionStatus, BaseManagerError>>;
+    disconnectConnection(request: DataSourceRequest): Promise<BWellTransactionResult<DisconnectConnectionResults, BaseManagerError>>;
     /**
-     * Permanently deletes a connection.
-     * Removes the connection and all associated data.
-     * @example
-     * ```typescript
-     * await sdk.connection.deleteConnection(
-     *   new DataSourceRequest({
-     *     connectionId: 'epic-123'
-     *   })
-     * );
-     * ```
+     * Deletes a Connection resource.
+     *
+     * @param {DataSourceRequest} request The request object containing the connectionId of the DataSource to delete.
+     *
+     * @returns {Promise<BWellTransactionResult<DeleteConnectionResults>>} A promise resolving to an object representing the list of Connection resources deleted, along with potential validation or GraphQL errors.
      */
-    deleteConnection(request: DataSourceRequest): Promise<BWellTransactionResult<ConnectionStatus, BaseManagerError>>;
+    deleteConnection(request: DataSourceRequest): Promise<BWellTransactionResult<DeleteConnectionResults, BaseManagerError>>;
     /**
-     * Retrieves OAuth URL for connection setup.
-     * Gets the authorization URL for OAuth-based connections.
-     * @example
-     * ```typescript
-     * const oauthUrl = await sdk.connection.getOauthUrl(
-     *   new DataSourceRequest({
-     *     connectionId: 'epic-123'
-     *   })
-     * );
-     * ```
+     * Retrieves an OAuth URL.
+     *
+     * @param {DataSourceRequest} request The request object containing the connectionId of the DataSource to retrieve the OAuth URL for.
+     *
+     * @returns {Promise<BWellQueryResult<OauthUrlResults>>} A promise resolving to an object representing the OAuth URL retrieved, along with potential validation or GraphQL errors.
      */
-    getOauthUrl(request: DataSourceRequest): Promise<BWellQueryResult<OAuthUrl, BaseManagerError>>;
+    getOauthUrl(request: DataSourceRequest): Promise<BWellQueryResult<OauthUrlResults, BaseManagerError>>;
 }
+export {};

package/dist/api/base/connection/connection-manager.js

@@ -1,4 +1 @@
-/**
- * @private
- */
 export const MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID = "data-connection-status";

package/dist/api/base/connection/connection-request.d.ts

@@ -13,18 +13,12 @@ export declare const UNDEFINED_USERNAME_ERROR = "username cannot be null or empt
 export declare const UNDEFINED_PASSWORD_ERROR = "password cannot be null or empty";
 /**
  * Input object for fetching a data source by connection id.
- * @category Inputs
- * @title DataSourceRequestInput
- * @excerpt Input for fetching data source by connection id
  */
 export type DataSourceRequestInput = {
     connectionId: string;
 };
 /**
- * Input object for creating a connection with authentication credentials.
- * @category Inputs
- * @title ConnectionRequestInput
- * @excerpt Input for creating connection with credentials
+ * Input object for fetching a data source by connection id.
  */
 export type ConnectionRequestInput = DataSourceRequestInput & {
     username: string;
@@ -45,25 +39,17 @@ export declare class ConnectionRequestValidator<T extends ConnectionRequestInput
 }
 /**
  * Base request object for interacting with the API using a connectionId.
- * @title BaseDataSourceRequest
- * @excerpt Base request object for interacting with the API using a connectionId
  */
 export declare class BaseDataSourceRequest<T extends DataSourceRequestInput> extends ValidationRequest<T> {
     protected validator: DataSourceRequestValidator<T>;
 }
 /**
  * Request object for interacting with the API using a connection id.
- * @category Requests
- * @title DataSourceRequest
- * @excerpt Request object for interacting with the API using a connection id
  */
 export declare class DataSourceRequest extends BaseDataSourceRequest<DataSourceRequestInput> {
 }
 /**
  * Request object for creating a connection.
- * @category Requests
- * @title ConnectionRequest
- * @excerpt Request object for creating a connection
  */
 export declare class ConnectionRequest extends BaseDataSourceRequest<ConnectionRequestInput> {
     protected validator: ConnectionRequestValidator<ConnectionRequestInput>;

package/dist/api/base/connection/connection-request.js

@@ -47,8 +47,6 @@ export class ConnectionRequestValidator {
 _ConnectionRequestValidator_dataSourceRequestValidator = new WeakMap();
 /**
  * Base request object for interacting with the API using a connectionId.
- * @title BaseDataSourceRequest
- * @excerpt Base request object for interacting with the API using a connectionId
  */
 export class BaseDataSourceRequest extends ValidationRequest {
     constructor() {
@@ -58,17 +56,11 @@ export class BaseDataSourceRequest extends ValidationRequest {
 }
 /**
  * Request object for interacting with the API using a connection id.
- * @category Requests
- * @title DataSourceRequest
- * @excerpt Request object for interacting with the API using a connection id
  */
 export class DataSourceRequest extends BaseDataSourceRequest {
 }
 /**
  * Request object for creating a connection.
- * @category Requests
- * @title ConnectionRequest
- * @excerpt Request object for creating a connection
  */
 export class ConnectionRequest extends BaseDataSourceRequest {
     constructor() {

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

@@ -1,2 +1,2 @@
-export { MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID, ConnectionManager, } from "./connection-manager.js";
+export { DataSourceResults, CreateConnectionResults, DisconnectConnectionResults, DeleteConnectionResults, OauthUrlResults, MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID, ConnectionManager, } from "./connection-manager.js";
 export { DataSourceRequest, DataSourceRequestInput, ConnectionRequest, ConnectionRequestInput, } from "./connection-request.js";