@borrowbetter/swsdk 0.1.1

package/dist/index.d.mts

@@ -0,0 +1,611 @@
+import { KyInstance } from 'ky';
+
+interface SpinwheelConfig {
+    apiKey: string;
+    sandbox?: boolean;
+}
+interface SpinwheelClients {
+    client: KyInstance;
+    secureClient: KyInstance;
+}
+type VerificationType = "SMS" | "PHONE_CALL" | "KYC" | "CREDIT_REPORT";
+interface ConnectPreverifiedPhoneAudit {
+    /** The date the user was verified. Formatted as YYYY-MM-DD */
+    verificationDate: string;
+    /** The date the user consented to verification. Formatted as YYYY-MM-DD */
+    userConsentDate: string;
+    /** The type of verification performed */
+    verificationType: VerificationType;
+}
+interface ConnectPreverifiedPhoneInput {
+    /** The phone number in E.164 format (e.g., +14155552671) */
+    phoneNumber: string;
+    /** The date of birth. Formatted as YYYY-MM-DD */
+    dateOfBirth: string;
+    /** An existing userId to connect with. One of extUserId or userId is required. */
+    userId?: string;
+    /** A unique external ID for the user. One of extUserId or userId is required. */
+    extUserId?: string;
+    /** Documentation of your own user verification */
+    audit: ConnectPreverifiedPhoneAudit;
+}
+interface ConnectNetworkTokenAudit {
+    /** The date the user consented to verification. Formatted as YYYY-MM-DD */
+    userConsentDate: string;
+}
+interface ConnectNetworkTokenInput {
+    /** A unique external ID for the user */
+    extUserId: string;
+    /** Network token */
+    networkToken: string;
+    /** Last 4 digits of SSN (exactly 4 characters) */
+    ssnLastFourDigits: string;
+    /** The date of birth. Formatted as YYYY-MM-DD */
+    dateOfBirth: string;
+    /** Documentation of your own user verification */
+    audit: ConnectNetworkTokenAudit;
+}
+type MessageType = "ERROR" | "WARN" | "INFO";
+interface SpinwheelStatusMessage {
+    desc: string;
+    type?: MessageType;
+}
+interface SpinwheelResponseStatus {
+    code: number;
+    desc: string;
+    messages?: SpinwheelStatusMessage[];
+}
+interface SpinwheelResponse<T> {
+    status: SpinwheelResponseStatus;
+    data: T;
+}
+type USStateCode = "AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY";
+type CreditBureau = "Equifax" | "Experian" | "TransUnion";
+type CreditReportType = "1_BUREAU.FULL";
+type CreditScoreModel = "VANTAGE_SCORE_3_0";
+type LiabilityStatus = "OPEN" | "CLOSED";
+type DebtType = "SECURED" | "UNSECURED" | "UNKNOWN";
+type AccountType = "CREDIT_LINE" | "INSTALLMENT" | "MORTGAGE" | "OPEN" | "REVOLVING" | "UNKNOWN";
+type TermsFrequency = "BIWEEKLY" | "DEFERRED" | "SEMI_MONTHLY" | "BI_MONTHLY" | "MONTHLY" | "SINGLE_PAYMENT_LOAN" | "QUARTERLY" | "SEMI_ANNUALLY" | "TRI_ANNUALLY" | "WEEKLY" | "ANNUALLY";
+type AccountOwnershipType = "AUTHORIZED_USER" | "COMAKER" | "INDIVIDUAL" | "JOINT_CONTRACTUAL_LIABILITY" | "JOINT_PARTICIPATING" | "MAKER" | "ON_BEHALF_OF" | "TERMINATED" | "UNDESIGNATED" | "DECEASED";
+type EcoaCode = "I" | "J" | "A" | "C" | "M" | "T" | "X";
+type ConsumerDisputeStatus = "DISPUTED" | "NOT_DISPUTED";
+type DerogatoryDataStatus = "DEROGATORY" | "NOT_DEROGATORY";
+type CollectionStatus = "IN_COLLECTION" | "NOT_IN_COLLECTION";
+type ChargeOffStatus = "CHARGED_OFF" | "NOT_CHARGED_OFF";
+type OverduePeriod = "LATE_30_DAYS" | "LATE_60_DAYS" | "LATE_90_DAYS" | "LATE_120_DAYS" | "NOT_OVERDUE";
+type AdverseRating = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "G" | "H" | "J" | "R" | "L" | "E" | "B" | "D";
+type InquiryPurposeType = "HARD" | "SOFT" | "OTHER";
+type BankruptcyType = "INDIVIDUAL" | "BUSINESS";
+type BankruptcyFiler = "INDIVIDUAL" | "JOINT";
+type BankruptcyDisposition = "FILED_CH_7" | "FILED_CH_11" | "FILED_CH_12" | "FILED_CH_13" | "DISCHARGED_CH_7" | "DISCHARGED_CH_11" | "DISCHARGED_CH_12" | "DISCHARGED_CH_13" | "DISMISSED_OR_CLOSED_CH_7" | "DISMISSED_OR_CLOSED_CH_11" | "DISMISSED_OR_CLOSED_CH_12" | "DISMISSED_OR_CLOSED_CH_13" | "INVOLUNTARY_CH_7" | "VOLUNTARY_CH_7" | "WAGE_EARNER";
+type AprType = "PURCHASE" | "BALANCE_TRANSFER" | "PENALTY" | "CASH_ADVANCE" | "INTRO";
+type DataStatusType = "IN_PROGRESS" | "COMPLETED" | "ERROR";
+type CapabilityStatus = "SUPPORTED" | "NOT_SUPPORTED" | "INSTITUTION_NOT_SUPPORTED" | "INSTITUTION_DISABLED" | "REFRESH_EXHAUSTED" | "NOT_PRIMARY_ACCOUNT_HOLDER" | "ACCOUNT_TERMINATED" | "CLOSED_ACCOUNT_NO_BALANCE" | "CLOSED_ACCOUNT" | "ACCOUNT_NUMBER_VERIFICATION_FAILED" | "FIELD_ERROR";
+type NarrativeCode = "UNPAID" | "FINANCIAL_COUNSELOR" | "ADJUSTMENT" | "WAGE_EARNER" | "NEW_LISTING" | "PAID" | "ACCOUNT_DISPUTED" | "PAYMENT" | "UNKNOWN" | "CHECKED" | "IN_BANKRUPTCY";
+type CollectionAccountStatus = NarrativeCode;
+type LimitType = "FLEXIBLE" | "REGULAR";
+type StudentLoanType = "PUBLIC" | "PRIVATE" | "UNVERIFIED";
+type ResidencyType = "CURRENT" | "PREVIOUS";
+type AddressOwnership = "OWN" | "RENT" | "BUY";
+type AddressSource = "EQUIFAX" | "TRANSUNION" | "OTHER" | "AUTOMATED_UPDATE";
+type EmploymentStatusType = "CURRENT" | "PREVIOUS";
+type LiabilityType = "STUDENT_LOAN" | "CREDIT_CARD" | "HOME_LOAN" | "AUTO_LOAN" | "PERSONAL_LOAN" | "MISCELLANEOUS_LIABILITY";
+interface DateWithFormat {
+    value: string;
+    format: string;
+}
+interface SpinwheelAddress {
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    state: USStateCode;
+    zip: string;
+    zipExtension?: string;
+}
+interface UserProfile {
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    phoneNumber?: string;
+    emailAddress?: string;
+    ssnLastFourDigits?: string;
+    dob?: string;
+    dateOfBirth?: string;
+    creditScore?: number;
+    model?: CreditScoreModel;
+    addresses?: SpinwheelAddress[];
+}
+interface LoanSummary {
+    noOfLoans: number;
+    currentOutstandingBalance: number;
+    minimumPaymentAmount: number;
+    interestRate?: number;
+    interestRateDerived?: number;
+    updatedOn?: number;
+    createdOn?: number;
+}
+interface CreditCardSummary {
+    noOfCreditCards: number;
+    currentOutstandingBalance: number;
+    availableCredit: number;
+    creditUtilization: number;
+    updatedOn: number;
+}
+interface LiabilityGroupPayoffQuote {
+    studentLoanIds: string[];
+    liabilityGroupId: string;
+    payoffAmount: number;
+    payoffGoodThroughDate: string;
+    updatedOn: number;
+}
+interface StudentLoanSummary extends LoanSummary {
+    liabilityGroupPayoffQuotes?: LiabilityGroupPayoffQuote[];
+}
+interface Narrative {
+    code: NarrativeCode;
+    description: string;
+}
+interface LiabilityTransfers {
+    transferredFrom?: {
+        creditorName: string;
+    };
+    transferredTo?: {
+        creditorName: string;
+    };
+}
+interface PaymentHistoryDetail {
+    date: string;
+    description: string;
+    code: string;
+}
+interface PaymentHistory {
+    lastAssessedStatementDate?: string;
+    details?: PaymentHistoryDetail[];
+}
+interface LiabilityProfile {
+    accountOriginationDate?: string;
+    status?: LiabilityStatus;
+    interestRateDerived?: number;
+    loanOriginationAmount?: number;
+    highCreditAmount?: number;
+    accountRating?: string;
+    liabilitySubtype?: string;
+    debtType?: DebtType;
+    pendingLoanTermInMonthsDerived?: number;
+    loanTermInMonths?: number;
+    termsFrequency?: TermsFrequency;
+    accountOwnershipType?: AccountOwnershipType;
+    ecoaCode?: EcoaCode;
+    reviewedInMonths?: number;
+    accountType?: AccountType;
+    consumerDisputeStatus?: ConsumerDisputeStatus;
+    derogatoryDataStatus?: DerogatoryDataStatus;
+    collectionStatus?: CollectionStatus;
+    chargeOffStatus?: ChargeOffStatus;
+    chargeOffAmount?: number;
+    accountTypeCode?: string;
+    accountNumberLastFour?: string;
+    adverseRatingCount?: number;
+    highestAdverseRating?: AdverseRating;
+    mostRecentAdverseRating?: AdverseRating;
+    secondMostRecentAdverseRating?: AdverseRating;
+    closedDateWithFormat?: DateWithFormat;
+    reportedDateWithFormat?: DateWithFormat;
+    chargeOffDateWithFormat?: DateWithFormat;
+    firstDelinquencyDateWithFormat?: DateWithFormat;
+    lastActivityDateWithFormat?: DateWithFormat;
+    highestAdverseRatingDateWithFormat?: DateWithFormat;
+    mostRecentAdverseRatingDateWithFormat?: DateWithFormat;
+    secondMostRecentAdverseRatingDateWithFormat?: DateWithFormat;
+    liabilityTransfers?: LiabilityTransfers;
+    narratives?: Narrative[];
+    paymentHistory?: PaymentHistory;
+    loanType?: StudentLoanType;
+    collectionAccountStatus?: CollectionAccountStatus;
+}
+interface CardProfile extends Omit<LiabilityProfile, "loanTermInMonths"> {
+    creditLimit?: number;
+    creditUtilization?: number;
+    creditCardNumberMasked?: string;
+    availableCreditDerived?: number;
+    limitType?: LimitType;
+}
+interface BalanceDetails {
+    outstandingBalance: number;
+    updatedOn?: number;
+}
+interface StatementSummary {
+    statementBalance?: number;
+    principalBalance?: number;
+    minimumPaymentAmount?: number;
+    dueDate?: string;
+    overduePeriod?: OverduePeriod;
+    amountPastDue?: number;
+    updatedOn?: number;
+    statementDateWithFormat?: DateWithFormat;
+    lastPaymentDateWithFormat?: DateWithFormat;
+    refreshedFields?: {
+        lastPaymentDate?: DateWithFormat & {
+            updatedOn: number;
+        };
+        dueDay?: DateWithFormat & {
+            updatedOn: number;
+        };
+        lastPaymentAmount?: {
+            value: number;
+            updatedOn: number;
+        };
+    };
+}
+interface PayoffSummary {
+    payoffAmount: number;
+    payoffGoodThroughDate: string;
+    updatedOn: number;
+}
+interface CreditorAddress extends SpinwheelAddress {
+    addressType?: ResidencyType;
+    reportedDate?: string;
+    reportedDateWithFormat?: DateWithFormat;
+}
+interface Creditor {
+    originalName?: string;
+    industryType?: string;
+    industryCode?: string;
+    phoneNumber?: string;
+    bureauSubscriberCode?: string;
+    address?: SpinwheelAddress;
+    billingAddresses?: CreditorAddress[];
+}
+interface CapabilityAvailability {
+    availability: CapabilityStatus;
+    description?: string;
+    liabilityGroupId?: string;
+    fieldErrors?: {
+        field: string;
+        error: CapabilityStatus;
+        description?: string;
+    }[];
+}
+interface Capabilities {
+    payments?: {
+        billPayment?: CapabilityAvailability;
+    };
+    data?: {
+        realtimeBalance?: CapabilityAvailability;
+        statementSummary?: CapabilityAvailability;
+        payoffSummary?: CapabilityAvailability;
+        liabilityGroupPayoffQuote?: CapabilityAvailability;
+    };
+}
+interface BaseLiability {
+    displayName?: string;
+    logoUrl: string;
+    balanceDetails: BalanceDetails;
+    statementSummary: StatementSummary;
+    creditor?: Creditor;
+    capabilities: Capabilities;
+    updatedOn?: number;
+    createdOn?: number;
+}
+interface HomeLoan extends BaseLiability {
+    homeLoanId: string;
+    liabilityProfile: LiabilityProfile;
+}
+interface AutoLoan extends BaseLiability {
+    autoLoanId: string;
+    liabilityProfile: LiabilityProfile;
+    payoffSummary?: PayoffSummary;
+}
+interface PersonalLoan extends BaseLiability {
+    personalLoanId: string;
+    liabilityProfile: LiabilityProfile;
+}
+interface StudentLoan extends BaseLiability {
+    studentLoanId: string;
+    liabilityProfile: LiabilityProfile;
+}
+interface MiscellaneousLiability extends BaseLiability {
+    miscellaneousLiabilityId: string;
+    liabilityProfile: LiabilityProfile;
+}
+interface Apr {
+    rate: number;
+    type: AprType;
+    applicableBalance?: number;
+    expirationDate?: string;
+    updatedOn: number;
+}
+interface CreditCard extends BaseLiability {
+    creditCardId: string;
+    cardProfile: CardProfile;
+    aprs?: Apr[];
+}
+interface CreditReportAddress extends SpinwheelAddress {
+    residencyType?: ResidencyType;
+    addressOwnership?: AddressOwnership;
+    addressSource?: AddressSource;
+    residencyDurationInMonths?: number;
+    reportedDate?: string;
+    reportedDateWithFormat?: DateWithFormat;
+    firstReportedDateWithFormat?: DateWithFormat;
+}
+interface FormerName {
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+}
+interface EmploymentHistory {
+    employerName?: string;
+    position?: string;
+    startDateWithFormat?: DateWithFormat;
+    reportedDateWithFormat?: DateWithFormat;
+    employmentStatus?: EmploymentStatusType;
+}
+interface CreditReportProfile {
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+    creditScore?: number;
+    model?: CreditScoreModel;
+    dateOfBirth?: string;
+    ssn?: string;
+    formerNames?: FormerName[];
+    addresses?: CreditReportAddress[];
+    employmentHistory?: EmploymentHistory[];
+    updatedOn?: number;
+    createdOn?: number;
+}
+interface Inquiry {
+    inquirerName?: string;
+    phoneNumber?: string;
+    inquiryDate?: string;
+    inquirerIndustryCode?: string;
+    purposeType?: InquiryPurposeType;
+    sourceBureau?: CreditBureau;
+    bureauSubscriberCode?: string;
+    address?: SpinwheelAddress;
+}
+interface BankruptcyCourt {
+    industryType?: string;
+    industryCode?: string;
+    bureauSubscriberCode?: string;
+}
+interface Bankruptcy {
+    caseNumber?: string;
+    type?: BankruptcyType;
+    filer?: BankruptcyFiler;
+    disposition?: BankruptcyDisposition;
+    priorDisposition?: BankruptcyDisposition;
+    liabilityAmount?: number;
+    assetAmount?: number;
+    exemptAmount?: number;
+    court?: BankruptcyCourt;
+    narratives?: Narrative[];
+    filedDateWithFormat?: DateWithFormat;
+    dispositionDateWithFormat?: DateWithFormat;
+    verifiedDateWithFormat?: DateWithFormat;
+    reportedDateWithFormat?: DateWithFormat;
+}
+interface CreditScoreFactor {
+    code: string;
+    description: string;
+}
+interface CreditScoreDetail {
+    reportedDate?: string;
+    creditScore?: number;
+    model?: CreditScoreModel;
+    sourceBureau?: CreditBureau;
+    riskBasedPricingPercentage?: number;
+    riskBasedPricingMin?: number;
+    riskBasedPricingMax?: number;
+    factors?: CreditScoreFactor[];
+}
+interface CreditAttribute {
+    description: string;
+    value: string;
+}
+interface CreditReportSummary {
+    totalSecuredDebtAmount?: number;
+    securedDebtLiabilitiesCount?: number;
+    totalUnsecuredDebtAmount?: number;
+    unsecuredDebtLiabilitiesCount?: number;
+    totalUnsecuredDebtExcludingStudent?: number;
+    unsecuredDebtExcludingStudentCount?: number;
+    totalUnknownDebtAmount?: number;
+    unknownDebtLiabilitiesCount?: number;
+}
+interface DataStatus {
+    status: DataStatusType;
+    updatedOn: number;
+}
+interface ConnectionStatus {
+    statusCode: number;
+    description: string;
+    lastAuthAttemptOn?: number;
+    isAuthSuccessful?: boolean;
+    isValid?: boolean;
+    isSecurityStepPending?: boolean;
+    lastSuccessfulAuthOn?: number;
+    dataStatus?: DataStatus;
+}
+interface CreditReport {
+    id: string;
+    sourceBureau: CreditBureau;
+    type: CreditReportType;
+    profile?: CreditReportProfile;
+    inquiries?: Inquiry[];
+    bankruptcies?: Bankruptcy[];
+    creditScoreDetails?: CreditScoreDetail[];
+    creditAttributes?: CreditAttribute[];
+    summary?: CreditReportSummary;
+    connectionStatus?: ConnectionStatus;
+    updatedOn?: number;
+    createdOn?: number;
+}
+interface UserData {
+    userId: string;
+    extUserId?: string;
+    connectionId?: string;
+    connectionStatus?: string;
+    networkToken?: string;
+    profile?: UserProfile;
+}
+interface HydratedUserData {
+    userId: string;
+    extUserId?: string;
+    isBorrower?: boolean;
+    isChampion?: boolean;
+    networkToken?: string;
+    updatedOn: number;
+    createdOn: number;
+    profile?: UserProfile;
+    autoLoanSummary?: LoanSummary;
+    homeLoanSummary?: LoanSummary;
+    personalLoanSummary?: LoanSummary;
+    miscellaneousLiabilitySummary?: LoanSummary;
+    creditCardSummary?: CreditCardSummary;
+    studentLoanSummary?: StudentLoanSummary;
+    creditReports?: CreditReport[];
+    homeLoans?: HomeLoan[];
+    autoLoans?: AutoLoan[];
+    personalLoans?: PersonalLoan[];
+    studentLoans?: StudentLoan[];
+    miscellaneousLiabilities?: MiscellaneousLiability[];
+    creditCards?: CreditCard[];
+}
+type ConnectPreverifiedPhoneResponse = SpinwheelResponse<UserData>;
+type ConnectNetworkTokenResponse = SpinwheelResponse<UserData>;
+type GetUserResponse = SpinwheelResponse<HydratedUserData>;
+interface FetchDebtProfileOptions {
+    /** Filter by liability type */
+    liabilityType?: LiabilityType;
+    /** Credit report configuration */
+    creditReport?: {
+        /** Credit bureau source. Defaults to bureau configured during onboarding. */
+        sourceBureau?: CreditBureau;
+        /** Type of credit report requested */
+        type: CreditReportType;
+    };
+    /** Credit score configuration */
+    creditScore?: {
+        /** Credit bureau source. Defaults to bureau configured during onboarding. */
+        sourceBureau?: CreditBureau;
+        /** Scoring model to use */
+        model: CreditScoreModel;
+    };
+}
+
+/**
+ * Connect API — Discover > Connect
+ *
+ * Handles user connection flows (preverified phone, network tokens).
+ */
+declare class ConnectAPI {
+    private clients;
+    constructor(clients: SpinwheelClients);
+    /**
+     * Connect a user that has already been pre-verified by phone number/SMS.
+     * Requires Spinwheel Support approval to enable.
+     *
+     * @see https://docs.spinwheel.io/reference/connect-preverified-phone-number
+     */
+    preverifiedPhone(input: ConnectPreverifiedPhoneInput): Promise<ConnectPreverifiedPhoneResponse>;
+    /**
+     * Connect a user using a network token obtained from user verification.
+     *
+     * @see https://docs.spinwheel.io/reference/create-network-user
+     */
+    networkToken(input: ConnectNetworkTokenInput): Promise<ConnectNetworkTokenResponse>;
+}
+
+/**
+ * Debt Profile API — Discover > Debt Profile
+ *
+ * Triggers asynchronous credit pulls. After calling `fetch`, use
+ * `userManagement.get()` to retrieve the resulting hydrated user data.
+ */
+declare class DebtProfileAPI {
+    private clients;
+    constructor(clients: SpinwheelClients);
+    /**
+     * Trigger a credit pull for a user's debt profile.
+     *
+     * This is an async operation — the credit pull happens in the background.
+     * Poll `userManagement.get(userId)` to retrieve results once complete.
+     *
+     * Note: Your implementation must display the Spinwheel End User Agreement:
+     * "By continuing you agree to the Spinwheel End User Agreement. Further,
+     * you are providing written instructions to Spinwheel Solutions, Inc.
+     * authorizing it to obtain your credit profile from any consumer reporting agency."
+     *
+     * @see https://docs.spinwheel.io/reference/fetch-debt-profile
+     */
+    fetch(userId: string, options: FetchDebtProfileOptions): Promise<void>;
+}
+
+type GetUserInput = {
+    userId: string;
+} | {
+    extUserId: string;
+};
+/**
+ * User Management API — Optimize > User Management
+ *
+ * Handles user profile retrieval with unmasked sensitive fields.
+ * Always uses the secure API endpoint.
+ */
+declare class UserManagementAPI {
+    private clients;
+    constructor(clients: SpinwheelClients);
+    /**
+     * Retrieve a user's full hydrated profile with unmasked account number and SSN.
+     *
+     * @param input - Either `userId` (Spinwheel's ID) or `extUserId` (your external ID)
+     * @see https://docs.spinwheel.io/reference/get-user-profile
+     */
+    get(input: GetUserInput): Promise<GetUserResponse>;
+}
+
+/**
+ * Spinwheel SDK
+ *
+ * Domain-based client for the Spinwheel credit data and debt profile API.
+ *
+ * @example
+ * ```typescript
+ * const spinwheel = new SpinwheelSDK({
+ *   apiKey: "your-api-key",
+ *   sandbox: true,
+ * });
+ *
+ * // Connect a user
+ * const { data } = await spinwheel.connect.preverifiedPhone({
+ *   phoneNumber: "+14155552671",
+ *   dateOfBirth: "1990-01-15",
+ *   extUserId: "your-user-id",
+ *   audit: {
+ *     verificationDate: "2025-01-01",
+ *     userConsentDate: "2025-01-01",
+ *     verificationType: "SMS",
+ *   },
+ * });
+ *
+ * // Trigger a credit pull
+ * await spinwheel.debtProfile.fetch(data.userId, {
+ *   creditReport: { sourceBureau: "TransUnion", type: "1_BUREAU.FULL" },
+ *   creditScore: { sourceBureau: "TransUnion", model: "VANTAGE_SCORE_3_0" },
+ * });
+ *
+ * // Retrieve hydrated profile
+ * const profile = await spinwheel.userManagement.get({ userId: data.userId });
+ * ```
+ */
+declare class SpinwheelSDK {
+    readonly connect: ConnectAPI;
+    readonly debtProfile: DebtProfileAPI;
+    readonly userManagement: UserManagementAPI;
+    constructor(config: SpinwheelConfig);
+}
+
+export { type AccountOwnershipType, type AccountType, type AddressOwnership, type AddressSource, type AdverseRating, type Apr, type AprType, type AutoLoan, type BalanceDetails, type Bankruptcy, type BankruptcyCourt, type BankruptcyDisposition, type BankruptcyFiler, type BankruptcyType, type Capabilities, type CapabilityAvailability, type CapabilityStatus, type CardProfile, type ChargeOffStatus, type CollectionAccountStatus, type CollectionStatus, type ConnectNetworkTokenAudit, type ConnectNetworkTokenInput, type ConnectNetworkTokenResponse, type ConnectPreverifiedPhoneAudit, type ConnectPreverifiedPhoneInput, type ConnectPreverifiedPhoneResponse, type ConnectionStatus, type ConsumerDisputeStatus, type CreditAttribute, type CreditBureau, type CreditCard, type CreditCardSummary, type CreditReport, type CreditReportAddress, type CreditReportProfile, type CreditReportSummary, type CreditReportType, type CreditScoreDetail, type CreditScoreFactor, type CreditScoreModel, type Creditor, type CreditorAddress, type DataStatus, type DataStatusType, type DateWithFormat, type DebtType, type DerogatoryDataStatus, type EcoaCode, type EmploymentHistory, type EmploymentStatusType, type FetchDebtProfileOptions, type FormerName, type GetUserResponse, type HomeLoan, type HydratedUserData, type Inquiry, type InquiryPurposeType, type LiabilityGroupPayoffQuote, type LiabilityProfile, type LiabilityStatus, type LiabilityTransfers, type LiabilityType, type LimitType, type LoanSummary, type MessageType, type MiscellaneousLiability, type Narrative, type NarrativeCode, type OverduePeriod, type PaymentHistory, type PaymentHistoryDetail, type PayoffSummary, type PersonalLoan, type ResidencyType, type SpinwheelAddress, type SpinwheelClients, type SpinwheelConfig, type SpinwheelResponse, type SpinwheelResponseStatus, SpinwheelSDK, type SpinwheelStatusMessage, type StatementSummary, type StudentLoan, type StudentLoanSummary, type StudentLoanType, type TermsFrequency, type USStateCode, type UserData, type UserProfile, type VerificationType };