@icanbwell/bwell-sdk-ts 1.54.0 → 1.55.0

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

@@ -1,5 +1 @@
-/**
- * Base manager for device registration; used to subscribe and unsubscribe devices for push notifications.
- */
-export class DeviceManager {
-}
+export {};

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

@@ -1,62 +1,55 @@
+import { DevicePlatform } from "../../../models/enums/index.js";
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
 /**
- * Error message for when deviceToken is missing
+ * Input type for registering a device to receive push notifications.
+ * @category Inputs
+ * @title RegisterDeviceRequestInput
+ * @excerpt Input for registering a device
  */
-export declare const INVALID_DEVICE_TOKEN_ERROR = "deviceToken is required";
-/**
- * Error message for when platformName is not a valid DevicePlatform value
- */
-export declare const INVALID_PLATFORM_NAME_ERROR = "platformName must be a valid DevicePlatform value";
-/**
- * Error message for when applicationName is missing
- */
-export declare const INVALID_APPLICATION_NAME_ERROR = "applicationName is required";
-/**
- * Enum for the device platform; currently only supports IOS and ANDROID
- */
-declare enum DevicePlatformEnum {
-    IOS = "IOS",
-    ANDROID = "ANDROID"
-}
-/**
- * Type for the device platform; currently only supports IOS and ANDROID
- */
-export type DevicePlatform = `${DevicePlatformEnum}`;
-/**
- * Base input for device request; used directly by DeregisterDeviceRequest
- */
-export type DeviceRequestInput = {
+export type RegisterDeviceRequestInput = {
     deviceToken: string;
-};
-/**
- * Input for the register device request
- */
-export type RegisterDeviceRequestInput = DeviceRequestInput & {
     platformName: DevicePlatform;
     applicationName: string;
 };
 /**
- * Base validator for device requests - only deviceToken is required in both request types
+ * Validator for RegisterDeviceRequestInput.
+ * Validates device token, platform name, and application name fields.
  */
-export declare class DeviceRequestValidator<T extends DeviceRequestInput> implements Validator<T> {
-    validate(data: T, errors: ErrorsCollector): void;
+declare class RegisterDeviceRequestValidator implements Validator<RegisterDeviceRequestInput> {
+    validate(data: RegisterDeviceRequestInput, errors: ErrorsCollector): void;
 }
 /**
- * Validator for RegisterDeviceRequest - checks that platform, applicationName and deviceToken are valid
+ * Request class for registering a device.
+ * @category Requests
+ * @title RegisterDeviceRequest
+ * @excerpt Request for registering a device
  */
-export declare class RegisterDeviceRequestValidator<T extends RegisterDeviceRequestInput> extends DeviceRequestValidator<T> {
-    validate(data: T, errors: ErrorsCollector): void;
+export declare class RegisterDeviceRequest extends ValidationRequest<RegisterDeviceRequestInput> {
+    protected validator: RegisterDeviceRequestValidator;
 }
 /**
- * Request for registering a device
+ * Input object for deregistering a device
+ * @category Inputs
+ * @title DeregisterDeviceRequestInput
+ * @excerpt Input for deregistering a device
  */
-export declare class RegisterDeviceRequest extends ValidationRequest<RegisterDeviceRequestInput> {
-    protected validator: RegisterDeviceRequestValidator<RegisterDeviceRequestInput>;
+export type DeregisterDeviceRequestInput = {
+    deviceToken: string;
+};
+/**
+ * Validator for DeregisterDeviceRequestInput.
+ * Validates the device token field.
+ */
+declare class DeregisterDeviceRequestValidator implements Validator<DeregisterDeviceRequestInput> {
+    validate(data: DeregisterDeviceRequestInput, errors: ErrorsCollector): void;
 }
 /**
- * Request for deregistering a device
+ * Request class for de-registering a device.
+ * @category Requests
+ * @title DeregisterDeviceRequest
+ * @excerpt Request for de-registering a device
  */
-export declare class DeregisterDeviceRequest extends ValidationRequest<DeviceRequestInput> {
-    protected validator: DeviceRequestValidator<DeviceRequestInput>;
+export declare class DeregisterDeviceRequest extends ValidationRequest<DeregisterDeviceRequestInput> {
+    protected validator: DeregisterDeviceRequestValidator;
 }
 export {};

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

@@ -1,49 +1,20 @@
+import { devicePlatformValues, } from "../../../models/enums/index.js";
 import { ValidationRequest, } from "../../../requests/index.js";
-import { isBlank } from "../../../utils/index.js";
+import { isBlank } from "../../../utils/string-utils.js";
+import { INVALID_APPLICATION_NAME_ERROR, INVALID_DEVICE_TOKEN_ERROR, INVALID_PLATFORM_NAME_ERROR, } from "./constants.js";
+const isValidDevicePlatform = (value) => {
+    return devicePlatformValues.includes(value);
+};
 /**
- * Error message for when deviceToken is missing
+ * Validator for RegisterDeviceRequestInput.
+ * Validates device token, platform name, and application name fields.
  */
-export const INVALID_DEVICE_TOKEN_ERROR = "deviceToken is required";
-/**
- * Error message for when platformName is not a valid DevicePlatform value
- */
-export const INVALID_PLATFORM_NAME_ERROR = "platformName must be a valid DevicePlatform value";
-/**
- * Error message for when applicationName is missing
- */
-export const INVALID_APPLICATION_NAME_ERROR = "applicationName is required";
-/**
- * Enum for the device platform; currently only supports IOS and ANDROID
- */
-var DevicePlatformEnum;
-(function (DevicePlatformEnum) {
-    DevicePlatformEnum["IOS"] = "IOS";
-    DevicePlatformEnum["ANDROID"] = "ANDROID";
-})(DevicePlatformEnum || (DevicePlatformEnum = {}));
-const devicePlatformValueCache = new Set(Object.values(DevicePlatformEnum));
-function isValidDevicePlatform(value) {
-    return devicePlatformValueCache.has(value);
-}
-function isNotValidDevicePlatform(value) {
-    return !isValidDevicePlatform(value);
-}
-/**
- * Base validator for device requests - only deviceToken is required in both request types
- */
-export class DeviceRequestValidator {
+class RegisterDeviceRequestValidator {
     validate(data, errors) {
         if (isBlank(data.deviceToken)) {
             errors.add(INVALID_DEVICE_TOKEN_ERROR);
         }
-    }
-}
-/**
- * Validator for RegisterDeviceRequest - checks that platform, applicationName and deviceToken are valid
- */
-export class RegisterDeviceRequestValidator extends DeviceRequestValidator {
-    validate(data, errors) {
-        super.validate(data, errors);
-        if (isNotValidDevicePlatform(data.platformName.toUpperCase())) {
+        if (!isValidDevicePlatform(data.platformName.toUpperCase())) {
             errors.add(INVALID_PLATFORM_NAME_ERROR);
         }
         if (isBlank(data.applicationName)) {
@@ -52,7 +23,10 @@ export class RegisterDeviceRequestValidator extends DeviceRequestValidator {
     }
 }
 /**
- * Request for registering a device
+ * Request class for registering a device.
+ * @category Requests
+ * @title RegisterDeviceRequest
+ * @excerpt Request for registering a device
  */
 export class RegisterDeviceRequest extends ValidationRequest {
     constructor() {
@@ -61,11 +35,25 @@ export class RegisterDeviceRequest extends ValidationRequest {
     }
 }
 /**
- * Request for deregistering a device
+ * Validator for DeregisterDeviceRequestInput.
+ * Validates the device token field.
+ */
+class DeregisterDeviceRequestValidator {
+    validate(data, errors) {
+        if (isBlank(data.deviceToken)) {
+            errors.add(INVALID_DEVICE_TOKEN_ERROR);
+        }
+    }
+}
+/**
+ * Request class for de-registering a device.
+ * @category Requests
+ * @title DeregisterDeviceRequest
+ * @excerpt Request for de-registering a device
  */
 export class DeregisterDeviceRequest extends ValidationRequest {
     constructor() {
         super(...arguments);
-        this.validator = new DeviceRequestValidator();
+        this.validator = new DeregisterDeviceRequestValidator();
     }
 }

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

@@ -1,2 +1,2 @@
-export { DeviceRegistrationResults, DeviceManager } from "./device-manager.js";
-export { DevicePlatform, DeviceRequestInput, RegisterDeviceRequestInput, DeregisterDeviceRequest, RegisterDeviceRequest, } from "./device-request.js";
+export * from "./device-request.js";
+export * from "./device-manager.js";

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

@@ -1,2 +1,2 @@
-export { DeviceManager } from "./device-manager.js";
-export { DeregisterDeviceRequest, RegisterDeviceRequest, } from "./device-request.js";
+export * from "./device-request.js";
+export * from "./device-manager.js";

package/dist/api/base/financial/coverage-request.d.ts

@@ -1,4 +1,4 @@
-import type { SearchDate, SearchReference, SearchString, TotalType } from "../../../graphql/schema.js";
+import type { SearchDate, SearchReference, SearchString } from "../../../graphql/schema.js";
 import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
 /**
  * Input type for Coverage FHIR resource requests.
@@ -12,18 +12,17 @@ export type CoverageRequestInput = PagedRequestInput & {
     sort?: Array<string | null> | string;
     patient?: SearchReference;
     beneficiary?: SearchReference;
-    total?: TotalType | null;
 };
 /**
  * Validator for Coverage request inputs.
- * Validates Coverage-specific search parameters.
+ * Validates the paged request properties as well as Coverage-specific search parameters.
  */
 declare class CoverageRequestValidator extends PagedRequestValidator<CoverageRequestInput> {
     #private;
     /**
-     * Validates Coverage-specific search parameters.
-     * @param data
-     * @param errors
+     * Validates the paged request properties as well as Coverage-specific search parameters.
+     * @param data CoverageRequestInput to validate
+     * @param errors ErrorsCollector to collect validation errors
      */
     validate(data: CoverageRequestInput, errors: ErrorsCollector): void;
 }

package/dist/api/base/financial/coverage-request.js

@@ -11,7 +11,7 @@ import { SearchReferenceValidator } from "../requests/search-reference.js";
 import { SearchStringValidator } from "../requests/search-string.js";
 /**
  * Validator for Coverage request inputs.
- * Validates Coverage-specific search parameters.
+ * Validates the paged request properties as well as Coverage-specific search parameters.
  */
 class CoverageRequestValidator extends PagedRequestValidator {
     constructor() {
@@ -21,21 +21,21 @@ class CoverageRequestValidator extends PagedRequestValidator {
         _CoverageRequestValidator_searchReferenceValidator.set(this, new SearchReferenceValidator());
     }
     /**
-     * Validates Coverage-specific search parameters.
-     * @param data
-     * @param errors
+     * Validates the paged request properties as well as Coverage-specific search parameters.
+     * @param data CoverageRequestInput to validate
+     * @param errors ErrorsCollector to collect validation errors
      */
     validate(data, errors) {
         super.validate(data, errors);
-        // Validate the id fields
+        // Validate SearchString fields
         if (isNotUndefined(data.id)) {
             __classPrivateFieldGet(this, _CoverageRequestValidator_searchStringValidator, "f").validate(data.id, errors);
         }
-        // Validate the lastUpdated fields
+        // Validate SearchDate fields
         if (isNotUndefined(data.lastUpdated)) {
             __classPrivateFieldGet(this, _CoverageRequestValidator_searchDateValidator, "f").validate(data.lastUpdated, errors);
         }
-        // Validate the patient and beneficiary fields
+        // Validate SearchReference fields
         if (isNotUndefined(data.beneficiary)) {
             __classPrivateFieldGet(this, _CoverageRequestValidator_searchReferenceValidator, "f").validate(data.beneficiary, errors);
         }

package/dist/api/base/financial/{explanation-of-benefit.d.ts → explanation-of-benefit-request.d.ts}

@@ -1,16 +1,22 @@
-import type { SearchDate, SearchReference, SearchString, SearchToken } from "../../../graphql/schema.js";
-import { PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/paged-request.js";
-import { ErrorsCollector } from "../../../requests/validator.js";
+import type { SearchDate, SearchReference, SearchString } from "../../../graphql/schema.js";
+import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
+import { FieldSortOrder } from "../requests/field-sort-order.js";
+/**
+ * Input type for ExplanationOfBenefit FHIR resource requests.
+ * @category Inputs
+ * @title ExplanationOfBenefitRequestInput
+ * @excerpt Input for ExplanationOfBenefit query with filters and pagination
+ */
 export type ExplanationOfBenefitRequestInput = PagedRequestInput & {
     id?: SearchString;
     lastUpdated?: SearchDate;
-    sort?: Array<string | null> | string;
+    sort?: FieldSortOrder[];
     patient?: SearchReference;
-    provider?: SearchReference;
-    coverage?: SearchReference;
-    status?: SearchToken;
-    created?: SearchDate;
 };
+/**
+ * Validator for ExplanationOfBenefit request inputs.
+ * Validates the paged request properties as well as ExplanationOfBenefit-specific search parameters.
+ */
 declare class ExplanationOfBenefitRequestValidator extends PagedRequestValidator<ExplanationOfBenefitRequestInput> {
     #private;
     /**
@@ -26,7 +32,7 @@ declare class ExplanationOfBenefitRequestValidator extends PagedRequestValidator
  * @title ExplanationOfBenefitsRequest
  * @excerpt Request object for fetching ExplanationOfBenefit FHIR resources with validation
  */
-export declare class ExplanationOfBenefitRequest extends PagedRequest<ExplanationOfBenefitRequestInput> {
+export declare class ExplanationOfBenefitsRequest extends PagedRequest<ExplanationOfBenefitRequestInput> {
     protected validator: ExplanationOfBenefitRequestValidator;
 }
 export {};

package/dist/api/base/financial/{explanation-of-benefit.js → explanation-of-benefit-request.js}

@@ -3,20 +3,22 @@ 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 _ExplanationOfBenefitRequestValidator_searchStringValidator, _ExplanationOfBenefitRequestValidator_searchDateValidator, _ExplanationOfBenefitRequestValidator_searchReferenceValidator, _ExplanationOfBenefitRequestValidator_searchTokenValidator;
-import { PagedRequest, PagedRequestValidator, } from "../../../requests/paged-request.js";
+var _ExplanationOfBenefitRequestValidator_searchStringValidator, _ExplanationOfBenefitRequestValidator_searchDateValidator, _ExplanationOfBenefitRequestValidator_searchReferenceValidator;
+import { PagedRequest, PagedRequestValidator, } from "../../../requests/index.js";
 import { isNotUndefined } from "../../../utils/type-utils.js";
 import { SearchDateValidator } from "../requests/search-date.js";
 import { SearchReferenceValidator } from "../requests/search-reference.js";
 import { SearchStringValidator } from "../requests/search-string.js";
-import { SearchTokenValidator } from "../requests/search-token.js";
+/**
+ * Validator for ExplanationOfBenefit request inputs.
+ * Validates the paged request properties as well as ExplanationOfBenefit-specific search parameters.
+ */
 class ExplanationOfBenefitRequestValidator extends PagedRequestValidator {
     constructor() {
         super(...arguments);
         _ExplanationOfBenefitRequestValidator_searchStringValidator.set(this, new SearchStringValidator());
         _ExplanationOfBenefitRequestValidator_searchDateValidator.set(this, new SearchDateValidator());
         _ExplanationOfBenefitRequestValidator_searchReferenceValidator.set(this, new SearchReferenceValidator());
-        _ExplanationOfBenefitRequestValidator_searchTokenValidator.set(this, new SearchTokenValidator());
     }
     /**
      * Validates the paged request properties as well as ExplanationOfBenefit-specific search parameters.
@@ -33,32 +35,20 @@ class ExplanationOfBenefitRequestValidator extends PagedRequestValidator {
         if (isNotUndefined(data.lastUpdated)) {
             __classPrivateFieldGet(this, _ExplanationOfBenefitRequestValidator_searchDateValidator, "f").validate(data.lastUpdated, errors);
         }
-        if (isNotUndefined(data.created)) {
-            __classPrivateFieldGet(this, _ExplanationOfBenefitRequestValidator_searchDateValidator, "f").validate(data.created, errors);
-        }
         // Validate SearchReference fields
         if (isNotUndefined(data.patient)) {
             __classPrivateFieldGet(this, _ExplanationOfBenefitRequestValidator_searchReferenceValidator, "f").validate(data.patient, errors);
         }
-        if (isNotUndefined(data.provider)) {
-            __classPrivateFieldGet(this, _ExplanationOfBenefitRequestValidator_searchReferenceValidator, "f").validate(data.provider, errors);
-        }
-        if (isNotUndefined(data.coverage)) {
-            __classPrivateFieldGet(this, _ExplanationOfBenefitRequestValidator_searchReferenceValidator, "f").validate(data.coverage, errors);
-        }
-        if (isNotUndefined(data.status)) {
-            __classPrivateFieldGet(this, _ExplanationOfBenefitRequestValidator_searchTokenValidator, "f").validate(data.status, errors);
-        }
     }
 }
-_ExplanationOfBenefitRequestValidator_searchStringValidator = new WeakMap(), _ExplanationOfBenefitRequestValidator_searchDateValidator = new WeakMap(), _ExplanationOfBenefitRequestValidator_searchReferenceValidator = new WeakMap(), _ExplanationOfBenefitRequestValidator_searchTokenValidator = new WeakMap();
+_ExplanationOfBenefitRequestValidator_searchStringValidator = new WeakMap(), _ExplanationOfBenefitRequestValidator_searchDateValidator = new WeakMap(), _ExplanationOfBenefitRequestValidator_searchReferenceValidator = new WeakMap();
 /**
  * Request object for fetching ExplanationOfBenefit FHIR resources.
  * @category Requests
  * @title ExplanationOfBenefitsRequest
  * @excerpt Request object for fetching ExplanationOfBenefit FHIR resources with validation
  */
-export class ExplanationOfBenefitRequest extends PagedRequest {
+export class ExplanationOfBenefitsRequest extends PagedRequest {
     constructor() {
         super(...arguments);
         this.validator = new ExplanationOfBenefitRequestValidator();

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

@@ -1,22 +1,54 @@
-import { ValidationError } from "../../../errors/index.js";
-import { GetCoveragesQueryResults, GetExplanationOfBenefitsQueryResults } from "../../../graphql/operations/types.js";
-import { BWellQueryResult } from "../../../results/index.js";
-import { BaseManagerError } from "../errors.js";
+import { CoverageBundle, ExplanationOfBenefitResponse } from "../../../models/index.js";
+import type { BWellQueryResult } from "../../../results/index.js";
+import type { BaseManagerError } from "../errors.js";
 import { CoveragesRequest } from "./coverage-request.js";
-import { ExplanationOfBenefitRequest } from "./explanation-of-benefit.js";
-export type CoveragesResults = GetCoveragesQueryResults["coverages"];
-export type ExplanationOfBenefitsResults = GetExplanationOfBenefitsQueryResults["explanationOfBenefits"];
+import { ExplanationOfBenefitsRequest } from "./explanation-of-benefit-request.js";
 /**
- * Interface representing a manager for handling operations related to financial resources.
+ * Financial Manager for insurance coverage and financial data access.
+ * Provides methods for retrieving financial records including coverage information,
+ * insurance plans, and payment details.
+ * @see https://build.fhir.org/financial-module.html
+ * @category Managers
+ * @title FinancialManager
+ * @excerpt Financial Manager for insurance coverage and financial data access
  */
 export interface FinancialManager {
     /**
-     * Retrieves coverage resources based on the provided request parameters.
+     * Retrieves a list of coverage resources for the authenticated user.
+     * Gets individual coverage records including insurance plans and benefits.
      *
-     * @param request - The request object containing parameters for filtering coverages.
-     * @returns A promise that resolves to a `BWellQueryResult` containing the coverage resources
-     *          or an error of type `ValidationError` or `BaseManagerError`.
+     * @param {CoveragesRequest} request - Request class instance for specifying the search criteria
+     *
+     * @returns {Promise<BWellQueryResult<CoverageBundle>>} A promise resolving to an object representing the list of coverages retrieved.
+     *
+     * @example
+     * ```typescript
+     * const paginatedCoverages = await sdk.financial.getCoverages(
+     *   new CoveragesRequest({
+     *     page: 0,
+     *     pageSize: 10,
+     *   })
+     * );
+     * ```
+     */
+    getCoverages(request: CoveragesRequest): Promise<BWellQueryResult<CoverageBundle, BaseManagerError>>;
+    /**
+     * Retrieves a list of explanation of benefit resources for the authenticated user.
+     * Gets adjudication details from the processing of claims.
+     *
+     * @param {ExplanationOfBenefitsRequest} request - Request class instance for specifying the search criteria
+     *
+     * @returns {Promise<BWellQueryResult<HealthDataResponse<ExplanationOfBenefit>>>} A promise resolving to an object representing the list of explanation of benefits retrieved.
+     *
+     * @example
+     * ```typescript
+     * const paginatedEOBs = await sdk.financial.getExplanationOfBenefits(
+     *   new ExplanationOfBenefitsRequest({
+     *     page: 0,
+     *     pageSize: 10,
+     *   })
+     * );
+     * ```
      */
-    getCoverages(request: CoveragesRequest): Promise<BWellQueryResult<CoveragesResults, ValidationError | BaseManagerError>>;
-    getExplanationOfBenefits(request: ExplanationOfBenefitRequest): Promise<BWellQueryResult<ExplanationOfBenefitsResults, ValidationError | BaseManagerError>>;
+    getExplanationOfBenefits(request: ExplanationOfBenefitsRequest): Promise<BWellQueryResult<ExplanationOfBenefitResponse, BaseManagerError>>;
 }

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

@@ -1,2 +1,3 @@
-export * from "./coverage-request.js";
-export * from "./explanation-of-benefit.js";
+export type { FinancialManager } from "./financial-manager.js";
+export { CoveragesRequest, type CoverageRequestInput, } from "./coverage-request.js";
+export { ExplanationOfBenefitsRequest, type ExplanationOfBenefitRequestInput, } from "./explanation-of-benefit-request.js";

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

@@ -1,2 +1,2 @@
-export * from "./coverage-request.js";
-export * from "./explanation-of-benefit.js";
+export { CoveragesRequest, } from "./coverage-request.js";
+export { ExplanationOfBenefitsRequest, } from "./explanation-of-benefit-request.js";