@experian-ecs/connected-api-sdk 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,1364 @@
+
+/** 
+ * Copyright © 2025 EXPERIAN. All rights reserved.
+ *
+ * This code is provided for inclusion in a website and is intended solely for execution by end
+ * users in web browsers or on an application server. Unauthorized modification, redistribution, or any other use is prohibited. This
+ * notice should be included with any use of this code.
+ *
+ * THIS CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+ * IN NO EVENT SHALL CSIDENTITY CORPORATION OR ITS AFFILIATES BE LIABLE FOR ANY CLAIM, DAMAGES, OR
+ * OTHER LIABILITY ARISING FROM OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS CODE.
+ */
+
+type ConnectedSolutionsAPIErrorData = {
+    dev_url: string;
+    code: string;
+    message: string;
+};
+type ConnectedSolutionsSDKErrorTypes = 'api_error' | 'auth_error' | 'sdk_error' | 'unknown_error';
+type ConnectedSolutionsClientRawError = {
+    message: string;
+    type: ConnectedSolutionsSDKErrorTypes;
+    status?: number;
+    data?: ConnectedSolutionsAPIErrorData;
+};
+declare function generateError(rawError: ConnectedSolutionsClientRawError): ConnectedSolutionsClientApiError | ConnectedSolutionsClientAuthError | ConnectedSolutionsClientSDKError | ConnectedSolutionsClientUnknownError;
+declare class ConnectedSolutionsClientError extends Error {
+    readonly message: string;
+    readonly data?: ConnectedSolutionsAPIErrorData;
+    readonly status?: number;
+    constructor(raw: ConnectedSolutionsClientRawError);
+    static generateError: typeof generateError;
+}
+declare class ConnectedSolutionsClientApiError extends ConnectedSolutionsClientError {
+    constructor(args: ConnectedSolutionsClientRawError);
+}
+declare class ConnectedSolutionsClientAuthError extends ConnectedSolutionsClientError {
+    constructor(args: ConnectedSolutionsClientRawError);
+}
+declare class ConnectedSolutionsClientUnknownError extends ConnectedSolutionsClientError {
+    constructor(args: ConnectedSolutionsClientRawError);
+}
+declare class ConnectedSolutionsClientSDKError extends ConnectedSolutionsClientError {
+    constructor(args: ConnectedSolutionsClientRawError);
+}
+
+type Entitlements = {
+    items: Entitlement[];
+};
+type Entitlement = {
+    id: string;
+    customer_id: string;
+    name: string;
+    description: string;
+    available_at: string;
+    entitled_products: EntitledProduct[];
+    created_at: string;
+    updated_at: string;
+};
+type EntitledProductStatus = 'ENTITLED' | 'ACTIVATED' | 'DEACTIVATED' | 'ACTIVATION_PENDING' | 'ACTIVATION_FAILED' | 'ACTIVATION_DROPPED';
+type EntitledProduct = {
+    id: EntitlementId;
+    global_product_id: GlobalProductId;
+    name: string;
+    description: string;
+    status: EntitledProductStatus;
+    status_updated_at: string;
+    type: string;
+    entitled_at: string;
+    next_action?: EntitlementNextAction;
+};
+type ActivationRule = {
+    rule_type: string;
+    missing_elements: string[];
+    dependency: string[];
+};
+type EntitlementNextAction = {
+    complete_activation_rules: {
+        rules: ActivationRule[];
+    };
+};
+type EntitleCustomerResponse = {
+    product: {
+        id: ProductConfigId;
+        name: string;
+        description: string;
+        category: string | null;
+        type: string | null;
+    };
+    entitled_at: string;
+};
+interface ProductEligibility {
+    id: ProductConfigId;
+    on_demand_eligibility: OnDemandEligibility;
+}
+type ProductDeliveryCadence = 'DAILY' | 'WEEKLY' | 'BI_WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY';
+interface OnDemandEligibility {
+    last_received_at: string;
+    next_available_at: string;
+    cadence: ProductDeliveryCadence;
+    eligible: boolean;
+    usage_count: number;
+}
+/**
+ * @example "ent_01GDJY5HNM4A68S8RFZ14DX35W"
+ */
+type EntitlementId = string;
+/**
+ * @example "cus_01GDJXZ7J6H3D4YCE56C64C9EA"
+ */
+type CustomerId = string;
+/**
+ * @example "procfg_01GDJY6T7JZCPQWWSFNDT3B77C"
+ */
+type ProductConfigId = string;
+/**
+ * @example "pro_01GDJY6T7JZCPQWWSFNDT3B77C"
+ */
+type GlobalProductId = string;
+
+declare class EntitlementsService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getEntitlements(requestOptions: {
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Entitlements>>;
+    getEntitlementById({ entitlement_id }: {
+        entitlement_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Entitlement>>;
+    createEntitlement(requestOptions: {
+        name: string;
+        description: string;
+        product_config_ids: string[];
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Entitlement>>;
+    updateEntitlement(requestOptions: {
+        entitlement_id: string;
+        product_config_ids: string[];
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Entitlement>>;
+    deleteEntitlement({ entitlement_id }: {
+        entitlement_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse>;
+    activateEntitlement({ entitlement_id }: {
+        entitlement_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Entitlement>>;
+    entitleCustomerToNewProduct(requestOptions: {
+        product_config_id: string;
+        entitlement_id: string;
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<EntitleCustomerResponse>>;
+    activateProduct(requestOptions: {
+        product_config_id: string;
+        entitlement_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Entitlement>>;
+    getProductEligibility(requestOptions: {
+        product_config_id: string;
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<ProductEligibility>>;
+}
+
+interface CreditScore {
+    score_id: string;
+    bureau: Bureau;
+    score_model: ScoreModel;
+    score_range: ScoreRange;
+    score_change: number;
+    score: number;
+    score_rating: ScoreRating;
+    score_date: string;
+    frequency: ScoreUpdateFrequency;
+    next_score_date: string;
+    credit_score_factor: CreditScoreFactor;
+    score_ingredients?: ScoreIngredient[];
+}
+type Bureau = 'EXPERIAN' | 'EQUIFAX' | 'TRANSUNION';
+type ScoreModelVersion = 'FICO8' | 'VANTAGE30' | 'FICO9' | 'FICO3' | 'FICOMORTGAGE2' | 'FICOBANKCARD2' | 'FICOBANKCARD8' | 'FICOBANKCARD9' | 'FICOAUTO2' | 'FICOAUTO8' | 'FICOAUTO9' | 'VANTAGE20';
+interface ScoreModel {
+    min: number;
+    max: number;
+    disclosure: {
+        short_form: string;
+        long_form: string;
+    };
+    version: ScoreModelVersion;
+    ranges: ScoreRange[];
+}
+interface ScoreRange {
+    start: number;
+    end: number;
+    rating: ScoreRating;
+    fill?: string;
+}
+type ScoreRating = 'Very Poor' | 'Poor' | 'Fair' | 'Good' | 'Very Good' | 'Excellent' | 'Exceptional';
+interface ScoreUpdateFrequency {
+    schedule: 'ONDEMAND' | 'ONSCHEDULE';
+    time_period: 'MONTHLY' | 'YEARLY' | 'WEEKLY' | 'DAILY' | 'SEMI-ANNUALLY' | 'ANNUALLY';
+    number_of_units_allowed: number;
+}
+interface CreditScoreFactor {
+    factors: ScoreFactor[] | null;
+}
+interface ScoreFactor {
+    code: string;
+    short_copy: string;
+    long_copy: string;
+    is_positive: boolean | null;
+}
+interface CreditScoreIngredient {
+    ingredientType: ScoreIngredientType;
+    bureau: Bureau;
+}
+interface ScoreIngredient {
+    rating_name: ScoreRating;
+    ingredient_type: ScoreIngredientType;
+    impact: ScoreIngredientImpact;
+    description: string;
+    help_text: string;
+    attributes: ScoreIngredientAttribute[];
+}
+type ScoreIngredientType = 'payment_history' | 'amount_of_debt' | 'credit_history_length' | 'amount_of_new_credit' | 'credit_mix';
+type ScoreIngredientImpact = '35%' | '30%' | '15%' | '10%';
+interface ScoreIngredientAttribute {
+    attribute_type: string;
+    display_name: string;
+    description: string;
+    help_text: string;
+    value: string;
+    value_type: ScoreIngredientAttributeValueType;
+    sub_value_type?: ScoreIngredientAttributeSubValueType;
+}
+type ScoreIngredientAttributeValueType = 'Integer' | 'String' | 'Percentage';
+type ScoreIngredientAttributeSubValueType = 'months' | 'years' | 'days' | 'amount';
+interface CreditScorePostRequest {
+    product_config_id: string;
+}
+
+type CreditScoreSimulator = FicoScoreSimulator | VantageScoreSimulator;
+type Scenario = FicoScenario | VantageScenario;
+type ScenarioVariation = VantageScenarioVariation | FicoScenarioVariation;
+type FicoScoreSimulator = {
+    bureau: Bureau;
+    score_date: string;
+    best_action: string;
+    score_model: ScoreModelVersion;
+    current_score: number;
+    current_score_rating: ScoreRating;
+    simulations: FicoScenario[];
+};
+type FicoScenario = {
+    category: SimulationCategoryType;
+    scenario: string;
+    title: string;
+    display_name: string;
+    description: string;
+    variations: FicoScenarioVariation[];
+};
+type VantageScoreSimulator = {
+    bureau: Bureau;
+    score_model: ScoreModelVersion;
+    current_score: number;
+    current_score_rating: ScoreRating;
+    simulations: VantageScenario[];
+};
+type VantageScenario = {
+    category: SimulationCategoryType;
+    scenario: string;
+    simulated_score: number;
+    score_impact: number;
+    impact: ImpactType;
+    value: number;
+    title: string;
+    display_name: string;
+    description: string;
+    simulation_error_code: number;
+    simulation_error: string;
+    variations: VantageScenarioVariation[];
+};
+type VantageScenarioVariation = {
+    value: number;
+    simulated_score: number;
+    simulated_score_rating: ScoreRating;
+    score_impact: number;
+    impact: ImpactType;
+    simulation_error_code: number;
+    simulation_error: string;
+};
+type FicoScenarioVariation = {
+    name: 'limit' | 'months' | 'amount' | 'date_opened' | 'balance_amount' | 'medical_flag' | 'I_MTG' | 'I_AUT' | 'I_STU' | 'I_OTH';
+    slider_min_value: number;
+    slider_max_value: number;
+    value: number;
+};
+type SimulationCategoryType = 'GENERAL_CREDIT' | 'REVOLVING_CREDIT' | 'MORTGAGE_ACCOUNTS' | 'INSTALLMENT_ACCOUNTS' | 'MAKING_PAYMENTS' | 'NEW_ACCOUNTS' | 'NEGATIVE_ACTIONS';
+type ImpactType = 'positive' | 'negative';
+interface CreditScoreSimulatorPostRequest {
+    scenario: string;
+    variations: FicoScenarioVariation[];
+}
+interface CreditScoreSimulatorPostResponse {
+    simulated_score: number;
+    simulated_score_rating: ScoreRating;
+    score_impact: number;
+    impact: ImpactType;
+}
+
+declare class CreditScoreSimulatorService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getSimulations(requestOptions: {
+        product_config_id: string;
+        run_all?: boolean;
+        cateogory?: SimulationCategoryType;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScoreSimulator>>;
+    simulateScenario(requestOptions: CreditScoreSimulatorPostRequest & {
+        product_config_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScoreSimulatorPostResponse>>;
+}
+
+type MappedScoreModelVersion = {
+    [key in ScoreModelVersion]: key;
+};
+type FicoScoreModelVersion = MappedScoreModelVersion['FICO3'] | MappedScoreModelVersion['FICO8'] | MappedScoreModelVersion['FICO9'] | MappedScoreModelVersion['FICOBANKCARD2'] | MappedScoreModelVersion['FICOBANKCARD8'] | MappedScoreModelVersion['FICOBANKCARD9'] | MappedScoreModelVersion['FICOAUTO2'] | MappedScoreModelVersion['FICOAUTO8'] | MappedScoreModelVersion['FICOAUTO9'] | MappedScoreModelVersion['FICOMORTGAGE2'];
+type VantageScoreModelVersion = MappedScoreModelVersion['VANTAGE20'] | MappedScoreModelVersion['VANTAGE30'];
+type PlanSetProgressStatus = 'OFF_TRACK' | 'ON_TRACK' | 'TARGET_SCORE_AND_PLAN_SET';
+type PlanNotSetProgressStatus = 'TARGET_SCORE_AND_PLAN_NOT_SET';
+type PlanCompletedProgressStatus = 'TARGET_NOT_MET' | 'COMPLETED';
+type BaseCreditScorePlan<ScoreModelType, ProgressStatusType, ScorePlanType> = {
+    score: number;
+    score_date: string;
+    minimum_attainable_score: number;
+    maximum_attainable_score: number;
+    score_model: ScoreModelType;
+    progress_status: ProgressStatusType;
+    score_plan: ScorePlanType;
+};
+type FicoCreditScorePlanNotSet = BaseCreditScorePlan<FicoScoreModelVersion, PlanNotSetProgressStatus, null>;
+type FicoCreditScorePlanSet = BaseCreditScorePlan<FicoScoreModelVersion, PlanSetProgressStatus, FicoScorePlanSet>;
+type FicoCreditScorePlanCompleted = BaseCreditScorePlan<FicoScoreModelVersion, PlanCompletedProgressStatus, FicoScorePlanCompleted>;
+type VantageCreditScorePlanNotSet = BaseCreditScorePlan<VantageScoreModelVersion, PlanNotSetProgressStatus, null>;
+type VantageCreditScorePlanSet = BaseCreditScorePlan<VantageScoreModelVersion, PlanSetProgressStatus, VantageScorePlanSet>;
+type VantageCreditScorePlanCompleted = BaseCreditScorePlan<VantageScoreModelVersion, PlanCompletedProgressStatus, VantageScorePlanCompleted>;
+type FicoCreditScorePlan = FicoCreditScorePlanNotSet | FicoCreditScorePlanSet | FicoCreditScorePlanCompleted;
+type VantageCreditScorePlan = VantageCreditScorePlanNotSet | VantageCreditScorePlanSet | VantageCreditScorePlanCompleted;
+type CreditScorePlan = FicoCreditScorePlan | VantageCreditScorePlan;
+type Action = {
+    code: string;
+    text: string;
+    additional_text?: string;
+};
+interface VantageStatement {
+    actions: Action[];
+}
+interface FicoStatement extends VantageStatement {
+    code: string;
+    text: string;
+}
+interface FicoScorePlanRevisionsRequest {
+    target_score: number;
+}
+interface VantageScorePlanRevisionsRequest {
+    max_actions_per_plan: number;
+}
+type ScorePlanRevisionsRequest = FicoScorePlanRevisionsRequest | VantageScorePlanRevisionsRequest;
+type BaseScorePlanRevision<StatementType, ScoreModelType> = {
+    original_score: number;
+    target_score: number;
+    target_duration: '3' | '6' | '9' | '12';
+    statement: StatementType;
+    score_model: ScoreModelType;
+};
+type FicoScorePlanRevision = BaseScorePlanRevision<FicoStatement, FicoScoreModelVersion>;
+type VantageScorePlanRevision = BaseScorePlanRevision<VantageStatement, VantageScoreModelVersion>;
+type ScorePlanRevision = FicoScorePlanRevision | VantageScorePlanRevision;
+type BaseScorePlanCreateResponse<ScorePlanRevisionType> = ScorePlanRevisionType & {
+    start_date: string;
+};
+type FicoScorePlanCreateResponse = BaseScorePlanCreateResponse<FicoScorePlanRevision>;
+type VantageScorePlanCreateResponse = BaseScorePlanCreateResponse<VantageScorePlanRevision>;
+type ScorePlanCreateResponse = FicoScorePlanCreateResponse | VantageScorePlanCreateResponse;
+type BaseScorePlanSet<ScorePlanCreateResponseType> = ScorePlanCreateResponseType & {
+    score_change: number;
+    remaining_days: number;
+    end_date: string;
+};
+type FicoScorePlanSet = BaseScorePlanSet<FicoScorePlanCreateResponse>;
+type VantageScorePlanSet = BaseScorePlanSet<VantageScorePlanCreateResponse>;
+type ScorePlanSet = FicoScorePlanSet | VantageScorePlanSet;
+type BaseScorePlanCompleted<ScorePlanSetType> = ScorePlanSetType & {
+    target_met_date: string;
+};
+type FicoScorePlanCompleted = BaseScorePlanCompleted<FicoScorePlanSet>;
+type VantageScorePlanCompleted = BaseScorePlanCompleted<VantageScorePlanSet>;
+type ScorePlanCompleted = FicoScorePlanCompleted | VantageScorePlanCompleted;
+
+declare class CreditScorePlannerService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getCreditScorePlan(requestOptions: {
+        product_config_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScorePlan>>;
+    createCreditScorePlan(requestOptions: ScorePlanRevision & {
+        product_config_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<ScorePlanCreateResponse>>;
+    deleteCreditScorePlan(requestOptions: {
+        product_config_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<void>>;
+    getCreditScorePlanRevisions(requestOptions: ScorePlanRevisionsRequest & {
+        product_config_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<ScorePlanRevision[]>>;
+}
+
+interface CreditAttributes {
+    bureau: Bureau;
+    reported_at: string;
+    categories: CreditAttributeCategory[];
+    attributes: CreditAttribute[];
+}
+interface CreditAttributeCategory {
+    name: AttributeCategoryName;
+    primary_attribute_name: string;
+    primary_attribute_rating: AttributeCategoryRating;
+    related_attribute_names: string[];
+    impact: AttributeCategoryImpact;
+    relevant_score_factors: AttributeRelevantScoreFactor[];
+    high_credit_utilization_accounts?: AttributeHighCreditUtilizationAccount[];
+    oldest_open_accounts?: AttributeOldestOpenAccount[];
+    recent_hard_inquiries?: AttributeHardInquiry[];
+}
+type AttributeCategoryName = 'PAYMENT_HISTORY' | 'CREDIT_UTILIZATION' | 'PUBLIC_RECORDS' | 'CREDIT_AGE' | 'CREDIT_MIX' | 'HARD_INQUIRIES';
+interface AttributeCategoryRating {
+    value: AttributeCategoryRatingName;
+    scale: AttributeCategoryRatingScale;
+}
+type AttributeCategoryRatingName = 'POOR' | 'AVERAGE' | 'GOOD' | 'EXCELLENT' | 'NO_RATING';
+interface AttributeCategoryRatingScale {
+    type: AttributeCategoryRatingScaleType;
+    values: AttributeCategoryRatingScaleValue[];
+}
+type AttributeCategoryRatingScaleType = 'COUNT' | 'PERCENTAGE' | 'MONTHS';
+interface AttributeCategoryRatingScaleValue {
+    value: AttributeCategoryRatingScaleValueName;
+    min: number;
+    max?: number;
+}
+type AttributeCategoryRatingScaleValueName = 'POOR' | 'AVERAGE' | 'GOOD' | 'EXCELLENT';
+type AttributeCategoryImpact = 'VERY_HIGH_IMPACT' | 'HIGH_IMPACT' | 'MEDIUM_IMPACT' | 'LOW_IMPACT';
+interface AttributeRelevantScoreFactor {
+    code: string;
+    positive: boolean;
+    short_description?: string;
+    long_description?: string;
+}
+interface AttributeHighCreditUtilizationAccount {
+    name: string;
+    utilization_percentage: number | null;
+    reported_at?: string;
+}
+interface AttributeOldestOpenAccount {
+    name: string;
+    type: string;
+    opened_at?: string;
+}
+interface AttributeHardInquiry {
+    name: string;
+    inquiried_at?: string;
+}
+interface CreditAttribute {
+    name: string;
+    description: string;
+    value: string;
+    exception?: string;
+}
+
+declare class CreditAttributesService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getCreditAttributes(fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditAttributes[]>>;
+}
+
+type BearerToken = {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    expires: string;
+};
+type AuthCredentials = {
+    grantType: 'client_credentials' | 'trusted_partner';
+    clientId: string;
+    clientSecret: string;
+    customerId?: string;
+};
+type AuthServiceConfig = Omit<ConnectedSolutionsSDKConfig, 'token'>;
+declare class AuthService {
+    #private;
+    config: AuthServiceConfig;
+    baseUrl: string;
+    constructor(config: AuthServiceConfig);
+    getAccessToken(credentials: AuthCredentials): Promise<{
+        data: BearerToken;
+        errors: any;
+        meta: {
+            status: number;
+            statusText: string;
+        };
+        error?: undefined;
+    } | {
+        data: any;
+        error: any;
+        meta: {
+            status: any;
+            statusText: any;
+        };
+        errors?: undefined;
+    }>;
+    getCacheLength(): number;
+    clearCache(): void;
+}
+
+type AlertMetadata = {
+    alert_id: string;
+    customer_id: string;
+    bureau: string;
+    alert_type: string;
+    alert_subtype: string;
+    event_key: string;
+    schema_version: string;
+    tenant_id: string;
+};
+type AlertDisposition = {
+    read_status: 'Y' | 'N';
+};
+type Address = {
+    address_line: string;
+    city: string;
+    state: string;
+    zipcode: string;
+};
+type Company = {
+    name: string;
+    phone: string;
+    business_type: string;
+    address: Address;
+};
+type DormantAccountDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+};
+type NewInquiryDetails = {
+    company: Company;
+    inquiry_date: string;
+    trigger: string;
+    trigger_description: string;
+};
+type NewAccountDetails = {
+    company: Company;
+    balance_amount: string;
+    open_date: string;
+    status_date: string;
+    trigger: string;
+    trigger_description: string;
+};
+type NewAddressDetails = {
+    current_address: Address;
+    previous_address: Address;
+};
+type SpecialCommentsDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type SkipCannotLocateDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type LostOrStolenCardDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type CardOverLimitDetails = {
+    company: Company;
+    balance_amount: string;
+    credit_limit: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type PastDueDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type DerogatoryDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type SettlementDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type ClosedAccountDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type AccountInBankruptcyDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type PublicRecordBankruptcyDetails = {
+    company: Company;
+    balance_amount: string;
+    court_name: string;
+    payment_status: string;
+    file_date: string;
+};
+type CollectionDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type DeceasedDetails = {
+    company: Company;
+    balance_amount: string;
+    is_collection: string;
+    payment_status: string;
+    open_date: string;
+    status_date: string;
+};
+type CreditBalanceIncreaseDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+    previous_balance_amount: string;
+    previous_balance_date: string;
+    credit_limit: string;
+    previous_credit_limit: string;
+};
+type CreditBalanceDecreaseDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+    previous_balance_amount: string;
+    previous_balance_date: string;
+    credit_limit: string;
+    previous_credit_limit: string;
+};
+type CreditLimitIncreaseDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+    previous_balance_amount: string;
+    previous_balance_date: string;
+    credit_limit: string;
+    previous_credit_limit: string;
+};
+type CreditLimitDecreaseDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+    previous_balance_amount: string;
+    previous_balance_date: string;
+    credit_limit: string;
+    previous_credit_limit: string;
+};
+type CreditUsageIncreaseDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+    previous_balance_amount: string;
+    previous_balance_date: string;
+    credit_limit: string;
+    previous_credit_limit: string;
+};
+type CreditUsageDecreaseDetails = {
+    company: Company;
+    balance_amount: string;
+    balance_date: string;
+    previous_balance_amount: string;
+    previous_balance_date: string;
+    credit_limit: string;
+    previous_credit_limit: string;
+};
+type AccountClosedDetails = {
+    company: Company;
+    balance_amount: string;
+    notice_date: string;
+    current_status: string;
+    previous_status: string;
+};
+type AccountCurrentDetails = {
+    company: Company;
+    balance_amount: string;
+    notice_date: string;
+    current_status: string;
+    previous_status: string;
+};
+type AccountImprovedDetails = {
+    company: Company;
+    balance_amount: string;
+    notice_date: string;
+    current_status: string;
+    previous_status: string;
+};
+type AccountPaidDetails = {
+    company: Company;
+    balance_amount: string;
+    notice_date: string;
+    current_status: string;
+    previous_status: string;
+};
+type CreditScoreTriggerReasons = {
+    score_rating_changed: string;
+    score_goal_achieved: string;
+    score_below_goal: string;
+    score_rating_increase: string;
+    score_rating_decrease: string;
+    score_increase: string;
+    score_decrease: string;
+};
+type CreditScoreFeaturePreferences = {
+    point_change: string;
+    risk_change: string;
+    goal_achieved: string;
+};
+type CreditScoreIncreaseDetails = {
+    alert_trigger_reasons: CreditScoreTriggerReasons;
+    feature_preferences: CreditScoreFeaturePreferences;
+    score_model: string;
+    new_score_id: string;
+    new_score_date: string;
+    new_score: string;
+    previous_score_id: string;
+    previous_score_date: string;
+    previous_score: string;
+    score_change: string;
+    new_score_rating: string;
+    previous_score_rating: string;
+    goal_value: string;
+};
+type CreditScoreDecreaseDetails = {
+    alert_trigger_reasons: CreditScoreTriggerReasons;
+    feature_preferences: CreditScoreFeaturePreferences;
+    score_model: string;
+    new_score_id: string;
+    new_score_date: string;
+    new_score: string;
+    previous_score_id: string;
+    previous_score_date: string;
+    previous_score: string;
+    score_change: string;
+    new_score_rating: string;
+    previous_score_rating: string;
+    goal_value: string;
+};
+type CreditScoreRatingIncreaseDetails = {
+    alert_trigger_reasons: CreditScoreTriggerReasons;
+    feature_preferences: CreditScoreFeaturePreferences;
+    score_model: string;
+    new_score_id: string;
+    new_score_date: string;
+    new_score: string;
+    previous_score_id: string;
+    previous_score_date: string;
+    previous_score: string;
+    score_change: string;
+    new_score_rating: string;
+    previous_score_rating: string;
+    goal_value: string;
+};
+type CreditScoreRatingDecreaseDetails = {
+    alert_trigger_reasons: CreditScoreTriggerReasons;
+    feature_preferences: CreditScoreFeaturePreferences;
+    score_model: string;
+    new_score_id: string;
+    new_score_date: string;
+    new_score: string;
+    previous_score_id: string;
+    previous_score_date: string;
+    previous_score: string;
+    score_change: string;
+    new_score_rating: string;
+    previous_score_rating: string;
+    goal_value: string;
+};
+type CreditScoreGoalAchievedDetails = {
+    alert_trigger_reasons: CreditScoreTriggerReasons;
+    feature_preferences: CreditScoreFeaturePreferences;
+    score_model: string;
+    new_score_id: string;
+    new_score_date: string;
+    new_score: string;
+    previous_score_id: string;
+    previous_score_date: string;
+    previous_score: string;
+    score_change: string;
+    new_score_rating: string;
+    previous_score_rating: string;
+    goal_value: string;
+};
+type CreditScoreBelowGoalDetails = {
+    alert_trigger_reasons: CreditScoreTriggerReasons;
+    feature_preferences: CreditScoreFeaturePreferences;
+    score_model: string;
+    new_score_id: string;
+    new_score_date: string;
+    new_score: string;
+    previous_score_id: string;
+    previous_score_date: string;
+    previous_score: string;
+    score_change: string;
+    new_score_rating: string;
+    previous_score_rating: string;
+    goal_value: string;
+};
+type AlertDetails = DormantAccountDetails | NewInquiryDetails | NewAccountDetails | NewAddressDetails | SpecialCommentsDetails | SkipCannotLocateDetails | LostOrStolenCardDetails | CardOverLimitDetails | PastDueDetails | DerogatoryDetails | SettlementDetails | ClosedAccountDetails | AccountInBankruptcyDetails | PublicRecordBankruptcyDetails | CollectionDetails | DeceasedDetails | CreditBalanceIncreaseDetails | CreditBalanceDecreaseDetails | CreditLimitIncreaseDetails | CreditLimitDecreaseDetails | CreditUsageIncreaseDetails | CreditUsageDecreaseDetails | AccountClosedDetails | AccountCurrentDetails | AccountImprovedDetails | AccountPaidDetails | CreditScoreIncreaseDetails | CreditScoreDecreaseDetails | CreditScoreRatingIncreaseDetails | CreditScoreRatingDecreaseDetails | CreditScoreGoalAchievedDetails | CreditScoreBelowGoalDetails;
+type AlertData<AlertDetailsType = AlertDetails> = {
+    alert_date: string;
+    alert_severity?: string;
+    alert_summary_header: string;
+    alert_summary_subheader: string;
+    alert_details: AlertDetailsType;
+    alert_disposition: AlertDisposition;
+};
+type Impact = {
+    impact_header: string;
+    impact_content_body: string;
+    risk_header: string;
+    risk_body: string;
+};
+type Supcontent = {
+    supcontent_header: string;
+    supcontent_body: string;
+};
+type Alert<AlertDetailsType = AlertDetails> = {
+    alert_metadata: AlertMetadata;
+    alert_data: AlertData<AlertDetailsType>;
+    impact: Impact;
+    supcontent: Supcontent;
+};
+type Alerts = {
+    pagination_token?: string;
+    alerts: Alert[];
+};
+type DeserializedAlertsPaginationToken = {
+    exAlertId: {
+        S: string;
+    };
+    exCustomerId: {
+        S: string;
+    };
+};
+type AlertCount = {
+    total: number;
+    read: number;
+    unread: number;
+};
+type TotalAlertCounts = {
+    credit: AlertCount;
+    identity: AlertCount;
+    score_change: AlertCount;
+};
+
+declare class AlertsService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getAlerts(requestOptions?: {
+        page_limit: number;
+        next_page_token: string | null;
+        disposition_status?: 'READ' | 'UNREAD';
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Alerts>>;
+    getAlertById({ id }: {
+        id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Alert>>;
+    markAlertAsRead({ id }: {
+        id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Alert>>;
+    getAlertCounts(fetchOptions?: RequestInit): Promise<ApiClientResponse<TotalAlertCounts>>;
+}
+
+type CreditReportType = 'EXPERIAN' | 'EXPERIAN_FICO2' | 'EXPERIAN_FICOMORTGAGE2' | 'EXPERIAN_FICO8' | 'EXPERIAN_FICO9' | 'EXPERIAN_VANTAGE30' | 'TRIBUREAU' | 'TRIBUREAU_EXPERIAN_FICO2' | 'TRIBUREAU_FICOMORTGAGE2' | 'TRIBUREAU_FICO8' | 'TRIBUREAU_VANTAGE30';
+type CreditReportScoreDetail = {
+    bureau: Bureau;
+    score_model: ScoreModelVersion;
+    score: number;
+};
+type CreditReportScoreRating = 'VERY_POOR' | 'POOR' | 'FAIR' | 'GOOD' | 'VERY_GOOD' | 'EXCELLENT' | 'EXCEPTIONAL';
+type ReportDisplayScoreDetails = {
+    score: number;
+    score_rating: CreditReportScoreRating;
+    score_date: string;
+    score_model: ScoreModelVersion;
+};
+type CreditReportMeta = {
+    id: string;
+    report_type: CreditReportType;
+    report_date: string;
+    report_read: boolean;
+    score_details: CreditReportScoreDetail[];
+};
+type PersonalAddress = {
+    house_number: string;
+    street_name: string;
+    suffix: string;
+    unit: string;
+    city: string;
+    state: string;
+    zip_code: string;
+};
+type Name = {
+    first_name: string;
+    middle_name: string;
+    last_name: string;
+};
+type Statement = {
+    created_at: string;
+    statement: string;
+};
+type PaymentHistoryCode = '' | 'No Data' | 'OK' | '30' | '60' | '90' | '120' | '150' | '180' | 'ND' | 'CLS' | 'CRD' | 'FS' | 'IC' | 'C' | 'F' | 'VS' | 'CO' | 'R' | 'PBC' | 'G' | 'D' | 'BK';
+type Month = 'jan' | 'feb' | 'mar' | 'apr' | 'may' | 'jun' | 'jul' | 'aug' | 'sep' | 'oct' | 'nov' | 'dec';
+type PaymentSummary = {
+    year: number;
+    summary_per_month: Record<Month, PaymentHistoryCode>;
+};
+type CreditorAddress = {
+    name: string;
+    address: string;
+    city: string;
+    state: string;
+    zip_code: string;
+};
+type ContactInfo = {
+    state: string;
+    name: string;
+    zip_code: string;
+    address: string;
+    city: string;
+    phone_number: string;
+};
+type Account = {
+    credit_usage?: number | null;
+    paid_off: number | null;
+    balance: string;
+    balance_updated_at: string;
+    credit_limit: number | null;
+    account_name: string;
+    account_number: string;
+    account_condition: string;
+    account_type: string;
+    opened_at: string;
+    category: string;
+    payment_summaries: PaymentSummary[];
+    payment_status: string;
+    payment_status_updated_at: string;
+    monthly_payment: string;
+    responsibility: string;
+    terms: string;
+    company_sold_to: string;
+    original_creditor: string;
+    comments: string[];
+    your_statements: string[];
+    contact_info: ContactInfo;
+    past_due_amount: number | null;
+    original_balance: number | null;
+    highest_balance: number | null;
+    last_payment_at: string | null;
+    creditor_comments: string[];
+    balloon_payment: string;
+};
+type CreditInquiry = {
+    creditor_name: string;
+    inquiry_at: string;
+    removal_at: string;
+    business_type: string;
+    creditor_address: CreditorAddress;
+    creditor_phone: string;
+};
+type CollectionAccount = {
+    account_name: string;
+    original_creditor: string;
+    balance: number | null;
+    balance_updated_at: string;
+    original_balance: number | null;
+    highest_balance: number | null;
+    account_number: string;
+    opened_at: string;
+    account_type: string;
+    payment_status: string;
+    payment_status_updated_at: string;
+    payment_summaries: PaymentSummary[];
+    comments: string[];
+    your_statements: string[];
+    contact_info: ContactInfo;
+};
+type PublicRecord = {
+    filed_at: string;
+    type: string;
+    court: string;
+    reference_number: string;
+    amount: string;
+};
+type ReportDisplay = {
+    bureau: Bureau;
+    personal_info: {
+        names: Name[];
+        year_of_birth: number;
+        current_address: PersonalAddress;
+        address_updated_at: string;
+        previous_addresses: PersonalAddress[];
+        employer_names: string[];
+        statements: Statement[];
+    };
+    accounts_info: {
+        credit_usage: number | null;
+        credit_available: number | null;
+        credit_limit: number | null;
+        accounts: Account[];
+    };
+    score_details: ReportDisplayScoreDetails[];
+    credit_inquiries: CreditInquiry[];
+    collection_accounts: CollectionAccount[];
+    public_records: PublicRecord[];
+};
+type CreditReport = {
+    report_data: string;
+    created_at: string;
+    read: boolean;
+    id: string;
+    report_display: ReportDisplay[];
+    type: CreditReportType;
+};
+
+declare class CreditReportsService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getReports(requestOptions?: {
+        product_config_id?: string;
+        include_fields?: string;
+        report_date?: string;
+        report_between?: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReport[]>>;
+    getReportById(requestOptions: {
+        id: string;
+        include_fields?: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReport>>;
+    getReportsMeta(requestOptions?: {
+        product_config_id?: string;
+        report_date?: string;
+        report_between?: string;
+        latest_only?: boolean;
+        report_read?: boolean;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReportMeta[]>>;
+    getReportMetaById(requestOptions: {
+        id: string;
+        product_config_id?: string;
+        include_fields?: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReportMeta>>;
+    markReportAsRead(requestOptions: {
+        id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse>;
+    orderReport(requestOptions: {
+        product_config_id: string;
+        include_fields?: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReport>>;
+}
+
+type Customer = {
+    customer_id: string;
+    reference_id: string;
+    people_id: string;
+    first_name: string;
+    middle_initial: string;
+    last_name: string;
+    suffix: string;
+    addresses: CustomerAddress[];
+    phones: CustomerPhone[];
+    emails: CustomerEmail[];
+    social_security_number: string;
+    date_of_birth: string;
+    disclosures: CustomerDisclosure[];
+    authentication_status: {
+        is_authenticated: boolean;
+        verification_method: string;
+        authenticated_at: string;
+    };
+    created_at: string;
+    updated_at: string;
+    outside_auth: boolean;
+};
+type CustomerAddress = {
+    address_type: string;
+    address1: string;
+    address2?: string;
+    city: string;
+    state: string;
+    zip: string;
+    country_code: string;
+};
+type CustomerPhone = {
+    phone_type: string;
+    phone_country_code: string;
+    phone_number: string;
+};
+type CustomerEmail = {
+    email_type: string;
+    email_address: string;
+};
+type CustomerDisclosure = {
+    accepted_at: string;
+};
+type CustomerSearchOptions = {
+    next_cursor?: string;
+    count: number;
+    people_id?: string;
+    reference_id?: string;
+    created_at?: string;
+    created_before?: string;
+    email_address?: string;
+    phone?: string;
+    name?: {
+        first_name?: string;
+        last_name?: string;
+    };
+    address?: CustomerAddress;
+    social_security_number?: string;
+    date_of_birth?: string;
+};
+type CustomerSearchResults = {
+    next_cursor?: string;
+    items: Customer[];
+};
+type CreateCustomerOptions = Partial<Pick<Customer, 'people_id' | 'reference_id' | 'first_name' | 'middle_initial' | 'last_name' | 'suffix' | 'social_security_number' | 'date_of_birth' | 'addresses' | 'phones' | 'emails' | 'outside_auth' | 'disclosures'>> & {
+    disclosure: CustomerDisclosure;
+};
+
+declare class CustomersService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getCustomerById(requestOptions: {
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<Customer>>;
+    updateCustomer(requestOptions: Pick<Customer, 'customer_id'> & Partial<Omit<Customer, 'customer_id'>>, fetchOptions?: RequestInit): Promise<ApiClientResponse<Customer>>;
+    deleteCustomer(requestOptions: {
+        customer_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse>;
+    createCustomer(requestOptions: CreateCustomerOptions, fetchOptions?: RequestInit): Promise<ApiClientResponse<Customer>>;
+    searchCustomers(requestOptions: CustomerSearchOptions, fetchOptions?: RequestInit): Promise<ApiClientResponse<CustomerSearchResults>>;
+}
+
+type AuthQuestions = {
+    questions: AuthQuestion[];
+    is_authenticated: boolean;
+    authentication_id: string;
+    authentication_session_id: string;
+};
+type AuthQuestion = {
+    question_order: number;
+    question_type: {
+        code: string;
+        description: string;
+    };
+    question_text: string;
+    question_select: {
+        choice_id: string;
+        text: string;
+    }[];
+};
+type AuthAnswersRequest = {
+    answers: AuthAnswer[];
+    authentication_id: string;
+    authentication_session_id: string;
+};
+type AuthAnswer = {
+    answer_order: number;
+    choice_id: string;
+};
+
+declare class CustomerAuthService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getAuthQuestions(fetchOptions?: RequestInit): Promise<ApiClientResponse<AuthQuestions>>;
+    submitAuthAnswers(answers: AuthAnswersRequest, fetchOptions?: RequestInit): Promise<ApiClientResponse>;
+}
+
+type CreateRegistrationsRequest = {
+    customer: Partial<Omit<Customer, 'disclosures'> & {
+        disclosure: CustomerDisclosure;
+    }>;
+    entitlement: {
+        name: string;
+        description: string;
+        available_at: string;
+        product_config_ids: string[];
+    };
+};
+type CreateRegistrationsResponse = {
+    customer: Customer;
+    entitlement: Entitlement;
+};
+
+declare class RegistrationsService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    createRegistration(requestOptions: CreateRegistrationsRequest, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreateRegistrationsResponse>>;
+}
+
+type ProductConfig = {
+    id: string;
+    name: string;
+    description: string;
+    product_type: string;
+    delivery: {
+        type: string;
+        cadence?: string;
+    };
+    created_at: string;
+    updated_at: string;
+};
+type ProductConfigs = {
+    previous_cursor: string;
+    next_cursor: string;
+    items: ProductConfig[];
+};
+
+declare class ProductConfigsService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getProductConfigs(fetchOptions?: RequestInit): Promise<ApiClientResponse<ProductConfigs>>;
+    getProductConfigById(requestOptions: {
+        product_config_id: string;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<ProductConfig>>;
+}
+
+type ConnectedSolutionsSDKConfigInternal = {
+    environment: 'PRODUCTION' | 'SANDBOX';
+    token: string | null;
+};
+type ConnectedSolutionsSDKConfig = Partial<ConnectedSolutionsSDKConfigInternal>;
+interface ConnectedSolutionsSDK {
+    alerts: AlertsService;
+    auth: AuthService;
+    creditReports: CreditReportsService;
+    creditScores: CreditScoresService;
+    creditAttributes: CreditAttributesService;
+    creditScorePlanner: CreditScorePlannerService;
+    creditScoreSimulator: CreditScoreSimulatorService;
+    customerAuth: CustomerAuthService;
+    customers: CustomersService;
+    entitlements: EntitlementsService;
+    productConfigs: ProductConfigsService;
+    registrations: RegistrationsService;
+}
+
+type ConnectedSolutionsClientMeta = {
+    status: number;
+    statusText: string;
+};
+type ConnectedSolutionsClientErrors = ConnectedSolutionsClientApiError | ConnectedSolutionsClientAuthError | ConnectedSolutionsClientUnknownError | ConnectedSolutionsClientSDKError;
+type ApiClientResponse<DataType = Record<string, unknown>> = {
+    data: DataType;
+    error: undefined;
+    meta: ConnectedSolutionsClientMeta;
+} | {
+    data: undefined;
+    error: ConnectedSolutionsClientErrors;
+    meta: ConnectedSolutionsClientMeta;
+};
+declare class ApiClient {
+    #private;
+    config: ConnectedSolutionsSDKConfig;
+    baseUrl: string;
+    contentstackUrl: string;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    setConfig(partialConfig: Partial<ConnectedSolutionsSDKConfig>): void;
+    fetchWithAuth<DataType>(input: RequestInfo, init?: RequestInit): Promise<ApiClientResponse<DataType>>;
+    fetchRequest<DataType>(input: RequestInfo, init?: RequestInit): Promise<ApiClientResponse<DataType>>;
+}
+
+declare class CreditScoresService extends ApiClient {
+    #private;
+    constructor(config: ConnectedSolutionsSDKConfig);
+    getCreditScores(options?: {
+        product_config_id?: string;
+        include_factors?: boolean;
+        include_ingredients?: boolean;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScore[]>>;
+    orderCreditScore(requestOptions: {
+        product_config_id: string;
+        include_factors?: boolean;
+        include_ingredients?: boolean;
+    }, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScore>>;
+}
+
+declare class SDKClient extends ApiClient implements ConnectedSolutionsSDK {
+    #private;
+    alerts: AlertsService;
+    auth: AuthService;
+    creditReports: CreditReportsService;
+    creditScores: CreditScoresService;
+    creditAttributes: CreditAttributesService;
+    creditScorePlanner: CreditScorePlannerService;
+    creditScoreSimulator: CreditScoreSimulatorService;
+    customerAuth: CustomerAuthService;
+    customers: CustomersService;
+    entitlements: EntitlementsService;
+    productConfigs: ProductConfigsService;
+    registrations: RegistrationsService;
+    static getInstance(config: ConnectedSolutionsSDKConfig): SDKClient;
+    static clearInstance(): void;
+    private constructor();
+}
+declare function createSDK(userConfig: ConnectedSolutionsSDKConfig): SDKClient;
+
+declare function isPlanCompleted(plan: CreditScorePlan): plan is FicoCreditScorePlanCompleted | VantageCreditScorePlanCompleted;
+declare function isPlanSet(plan: CreditScorePlan): plan is FicoCreditScorePlanCompleted | FicoCreditScorePlanSet | VantageCreditScorePlanCompleted | VantageCreditScorePlanSet;
+declare function isVantagePlan(plan: CreditScorePlan): plan is VantageCreditScorePlan;
+declare function isFicoPlan(plan: CreditScorePlan): plan is FicoCreditScorePlan;
+declare function isFicoRevisionsRequest(request: ScorePlanRevisionsRequest): request is FicoScorePlanRevisionsRequest;
+declare function isVantageRevisionsRequest(request: ScorePlanRevisionsRequest): request is VantageScorePlanRevisionsRequest;
+declare function isFicoRevision(revision: ScorePlanRevision): revision is FicoScorePlanRevision;
+declare function isVantageRevision(revision: ScorePlanRevision): revision is VantageScorePlanRevision;
+
+declare function isFicoSimulator(data?: CreditScoreSimulator): data is FicoScoreSimulator;
+declare function isVantageScenario(scenario?: Scenario): scenario is VantageScenario;
+declare function isFicoScenario(scenario: Scenario): scenario is FicoScenario;
+declare function isFicoScenarioVariation(variation?: ScenarioVariation): variation is FicoScenarioVariation;
+declare function isVantageScenarioVariation(variation?: ScenarioVariation): variation is VantageScenarioVariation;
+
+export { type Account, type AccountClosedDetails, type AccountCurrentDetails, type AccountImprovedDetails, type AccountInBankruptcyDetails, type AccountPaidDetails, type Action, type ActivationRule, type Address, type Alert, type AlertCount, type AlertData, type AlertDetails, type AlertDisposition, type AlertMetadata, type Alerts, type ApiClientResponse, type AttributeCategoryImpact, type AttributeCategoryName, type AttributeCategoryRating, type AttributeCategoryRatingName, type AttributeCategoryRatingScale, type AttributeCategoryRatingScaleType, type AttributeCategoryRatingScaleValue, type AttributeCategoryRatingScaleValueName, type AttributeHardInquiry, type AttributeHighCreditUtilizationAccount, type AttributeOldestOpenAccount, type AttributeRelevantScoreFactor, type AuthAnswer, type AuthAnswersRequest, type AuthCredentials, type AuthQuestion, type AuthQuestions, type AuthServiceConfig, type BearerToken, type Bureau, type CardOverLimitDetails, type ClosedAccountDetails, type CollectionAccount, type CollectionDetails, type Company, type ConnectedSolutionsAPIErrorData, ConnectedSolutionsClientApiError, ConnectedSolutionsClientAuthError, ConnectedSolutionsClientError, type ConnectedSolutionsClientErrors, type ConnectedSolutionsClientMeta, type ConnectedSolutionsClientRawError, ConnectedSolutionsClientSDKError, ConnectedSolutionsClientUnknownError, type ConnectedSolutionsSDK, type ConnectedSolutionsSDKConfig, type ConnectedSolutionsSDKConfigInternal, type ConnectedSolutionsSDKErrorTypes, type ContactInfo, type CreateCustomerOptions, type CreateRegistrationsRequest, type CreateRegistrationsResponse, type CreditAttribute, type CreditAttributeCategory, type CreditAttributes, type CreditBalanceDecreaseDetails, type CreditBalanceIncreaseDetails, type CreditInquiry, type CreditLimitDecreaseDetails, type CreditLimitIncreaseDetails, type CreditReport, type CreditReportMeta, type CreditReportScoreDetail, type CreditReportScoreRating, type CreditReportType, type CreditScore, type CreditScoreBelowGoalDetails, type CreditScoreDecreaseDetails, type CreditScoreFactor, type CreditScoreFeaturePreferences, type CreditScoreGoalAchievedDetails, type CreditScoreIncreaseDetails, type CreditScoreIngredient, type CreditScorePlan, type CreditScorePostRequest, type CreditScoreRatingDecreaseDetails, type CreditScoreRatingIncreaseDetails, type CreditScoreSimulator, type CreditScoreSimulatorPostRequest, type CreditScoreSimulatorPostResponse, type CreditScoreTriggerReasons, type CreditUsageDecreaseDetails, type CreditUsageIncreaseDetails, type CreditorAddress, type Customer, type CustomerAddress, type CustomerDisclosure, type CustomerEmail, type CustomerId, type CustomerPhone, type CustomerSearchOptions, type CustomerSearchResults, type DeceasedDetails, type DerogatoryDetails, type DeserializedAlertsPaginationToken, type DormantAccountDetails, type EntitleCustomerResponse, type EntitledProduct, type EntitledProductStatus, type Entitlement, type EntitlementId, type EntitlementNextAction, type Entitlements, type FicoCreditScorePlan, type FicoCreditScorePlanCompleted, type FicoCreditScorePlanNotSet, type FicoCreditScorePlanSet, type FicoScenario, type FicoScenarioVariation, type FicoScoreModelVersion, type FicoScorePlanCompleted, type FicoScorePlanCreateResponse, type FicoScorePlanRevision, type FicoScorePlanRevisionsRequest, type FicoScorePlanSet, type FicoScoreSimulator, type FicoStatement, type GlobalProductId, type Impact, type ImpactType, type LostOrStolenCardDetails, type MappedScoreModelVersion, type Month, type Name, type NewAccountDetails, type NewAddressDetails, type NewInquiryDetails, type OnDemandEligibility, type PastDueDetails, type PaymentHistoryCode, type PaymentSummary, type PersonalAddress, type PlanCompletedProgressStatus, type PlanNotSetProgressStatus, type PlanSetProgressStatus, type ProductConfigId, type ProductDeliveryCadence, type ProductEligibility, type PublicRecord, type PublicRecordBankruptcyDetails, type ReportDisplay, type ReportDisplayScoreDetails, type Scenario, type ScenarioVariation, type ScoreFactor, type ScoreIngredient, type ScoreIngredientAttribute, type ScoreIngredientAttributeSubValueType, type ScoreIngredientAttributeValueType, type ScoreIngredientImpact, type ScoreIngredientType, type ScoreModel, type ScoreModelVersion, type ScorePlanCompleted, type ScorePlanCreateResponse, type ScorePlanRevision, type ScorePlanRevisionsRequest, type ScorePlanSet, type ScoreRange, type ScoreRating, type ScoreUpdateFrequency, type SettlementDetails, type SimulationCategoryType, type SkipCannotLocateDetails, type SpecialCommentsDetails, type Statement, type Supcontent, type TotalAlertCounts, type VantageCreditScorePlan, type VantageCreditScorePlanCompleted, type VantageCreditScorePlanNotSet, type VantageCreditScorePlanSet, type VantageScenario, type VantageScenarioVariation, type VantageScoreModelVersion, type VantageScorePlanCompleted, type VantageScorePlanCreateResponse, type VantageScorePlanRevision, type VantageScorePlanRevisionsRequest, type VantageScorePlanSet, type VantageScoreSimulator, type VantageStatement, createSDK, createSDK as default, isFicoPlan, isFicoRevision, isFicoRevisionsRequest, isFicoScenario, isFicoScenarioVariation, isFicoSimulator, isPlanCompleted, isPlanSet, isVantagePlan, isVantageRevision, isVantageRevisionsRequest, isVantageScenario, isVantageScenarioVariation };