@burdenoff/sdk-libs 2026.627.2 → 2026.627.3

package/dist/modules/brainyrich/index.d.cts

@@ -0,0 +1,483 @@
+import { J as Json, S as SdkModule } from '../../module-JDbvil5h.cjs';
+import 'graphql-request';
+
+type BraAccountStatus = 'ACTIVE' | 'ARCHIVED' | 'CLOSED';
+type BraAccountType = 'ALTERNATIVE' | 'BANK' | 'BROKERAGE' | 'CASH' | 'CRYPTO' | 'LIABILITY' | 'REAL_ESTATE' | 'RETIREMENT';
+type BraAssetClass = 'ALTERNATIVE' | 'CASH' | 'COMMODITY' | 'CRYPTO' | 'EQUITY' | 'FIXED_INCOME' | 'REAL_ESTATE';
+type BraGoalProjection = 'AHEAD' | 'AT_RISK' | 'BEHIND' | 'ON_TRACK';
+type BraGoalStatus = 'ABANDONED' | 'ACHIEVED' | 'ACTIVE' | 'ON_HOLD';
+type BraGoalType = 'CUSTOM' | 'EDUCATION' | 'EMERGENCY_FUND' | 'HOME' | 'MAJOR_PURCHASE' | 'RETIREMENT' | 'WEALTH_GROWTH';
+type BraHouseholdStatus = 'ACTIVE' | 'INACTIVE' | 'ONBOARDING' | 'PROSPECT';
+type BraInsightSeverity = 'CRITICAL' | 'HIGH' | 'INFO' | 'LOW' | 'MEDIUM';
+type BraInsightStatus = 'ACKNOWLEDGED' | 'DISMISSED' | 'OPEN' | 'RESOLVED';
+type BraInsightType = 'CASH_DRAG' | 'CONCENTRATION_RISK' | 'DRIFT' | 'FEE_ANOMALY' | 'GOAL_AT_RISK' | 'REBALANCE_DUE' | 'TAX_OPPORTUNITY';
+type BraPortfolioStatus = 'ACTIVE' | 'ARCHIVED' | 'DRAFT';
+type BraRebalanceStatus = 'APPROVED' | 'CANCELLED' | 'DRAFT' | 'EXECUTED' | 'PROPOSED' | 'REJECTED';
+type BraRiskProfile = 'AGGRESSIVE' | 'BALANCED' | 'CONSERVATIVE' | 'GROWTH' | 'MODERATE';
+type BraTransactionType = 'BUY' | 'DEPOSIT' | 'DIVIDEND' | 'FEE' | 'INTEREST' | 'SELL' | 'TRANSFER' | 'WITHDRAWAL';
+interface BraHousehold {
+    id: string;
+    advisorId: string;
+    aum: number;
+    currency: string;
+    name: string;
+    notes?: string | null;
+    primaryContactEmail?: string | null;
+    primaryContactName?: string | null;
+    riskProfile: BraRiskProfile;
+    status: BraHouseholdStatus;
+    tags: string[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface BraHolding {
+    id: string;
+    accountId: string;
+    asOf?: string | null;
+    assetClass: BraAssetClass;
+    costBasis: number;
+    currency: string;
+    lastPrice: number;
+    marketValue: number;
+    name?: string | null;
+    portfolioId?: string | null;
+    quantity: number;
+    symbol: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    account?: BraAccount | null;
+}
+interface BraTransaction {
+    id: string;
+    accountId: string;
+    amount: number;
+    currency: string;
+    fee: number;
+    holdingId?: string | null;
+    notes?: string | null;
+    price: number;
+    quantity: number;
+    settleDate?: string | null;
+    symbol?: string | null;
+    tradeDate: string;
+    type: BraTransactionType;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface BraAccount {
+    id: string;
+    accountMask?: string | null;
+    cashBalance: number;
+    currency: string;
+    householdId?: string | null;
+    institution?: string | null;
+    isManual: boolean;
+    name: string;
+    ownerId: string;
+    status: BraAccountStatus;
+    type: BraAccountType;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    holdings?: BraHolding[];
+    transactions?: BraTransaction[];
+}
+interface BraModelAllocation {
+    id: string;
+    assetClass: BraAssetClass;
+    modelPortfolioId: string;
+    targetPct: number;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface BraModelPortfolio {
+    id: string;
+    baseCurrency: string;
+    description?: string | null;
+    isActive: boolean;
+    name: string;
+    riskProfile: BraRiskProfile;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    allocations?: BraModelAllocation[];
+}
+interface BraPortfolio {
+    id: string;
+    baseCurrency: string;
+    description?: string | null;
+    driftThresholdPct: number;
+    householdId?: string | null;
+    modelPortfolioId?: string | null;
+    name: string;
+    ownerId: string;
+    status: BraPortfolioStatus;
+    tags: string[];
+    targetAllocation?: Json | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    holdings?: BraHolding[];
+}
+interface BraGoalFunding {
+    id: string;
+    accountId: string;
+    allocationPct: number;
+    fixedAmount?: number | null;
+    goalId: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface BraGoal {
+    id: string;
+    currency: string;
+    householdId?: string | null;
+    monthlyContribution: number;
+    name: string;
+    notes?: string | null;
+    ownerId: string;
+    priority: number;
+    projection: BraGoalProjection;
+    status: BraGoalStatus;
+    tags: string[];
+    targetAmount: number;
+    targetDate: string;
+    type: BraGoalType;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    fundings?: BraGoalFunding[];
+}
+interface BraInsight {
+    id: string;
+    acknowledgedById?: string | null;
+    detail?: string | null;
+    metrics?: Json | null;
+    ownerId: string;
+    resolvedAt?: string | null;
+    severity: BraInsightSeverity;
+    status: BraInsightStatus;
+    subjectId: string;
+    subjectType: string;
+    title: string;
+    type: BraInsightType;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface BraRebalanceProposal {
+    id: string;
+    approvedById?: string | null;
+    driftPct: number;
+    executedAt?: string | null;
+    householdId?: string | null;
+    portfolioId: string;
+    proposedById?: string | null;
+    rationale?: string | null;
+    status: BraRebalanceStatus;
+    trades?: Json | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface BraNetWorthByClass {
+    assetClass: BraAssetClass;
+    marketValue: number;
+}
+interface BraNetWorthSummary {
+    accountCount: number;
+    byAssetClass: BraNetWorthByClass[];
+    currency: string;
+    ownerId: string;
+    totalCash: number;
+    totalMarketValue: number;
+    totalNetWorth: number;
+    workspaceId: string;
+}
+interface BraPageInfo {
+    cursor?: string | null;
+    hasMore: boolean;
+}
+interface BraAccountConnection {
+    items: BraAccount[];
+    pageInfo: BraPageInfo;
+}
+interface BraGoalConnection {
+    items: BraGoal[];
+    pageInfo: BraPageInfo;
+}
+interface BraHouseholdConnection {
+    items: BraHousehold[];
+    pageInfo: BraPageInfo;
+}
+interface BraInsightConnection {
+    items: BraInsight[];
+    pageInfo: BraPageInfo;
+}
+interface BraPortfolioConnection {
+    items: BraPortfolio[];
+    pageInfo: BraPageInfo;
+}
+interface BraTransactionConnection {
+    items: BraTransaction[];
+    pageInfo: BraPageInfo;
+}
+interface BraPaginationInput {
+    cursor?: string;
+    limit?: number;
+    offset?: number;
+}
+interface BraCreateHouseholdInput {
+    name: string;
+    advisorId?: string;
+    currency?: string;
+    notes?: string;
+    primaryContactEmail?: string;
+    primaryContactName?: string;
+    riskProfile?: BraRiskProfile;
+    status?: BraHouseholdStatus;
+    tags?: string[];
+}
+interface BraUpdateHouseholdInput {
+    aum?: number;
+    currency?: string;
+    name?: string;
+    notes?: string;
+    primaryContactEmail?: string;
+    primaryContactName?: string;
+    riskProfile?: BraRiskProfile;
+    status?: BraHouseholdStatus;
+    tags?: string[];
+}
+interface BraCreateAccountInput {
+    name: string;
+    accountMask?: string;
+    cashBalance?: number;
+    currency?: string;
+    householdId?: string;
+    institution?: string;
+    isManual?: boolean;
+    ownerId?: string;
+    status?: BraAccountStatus;
+    type?: BraAccountType;
+}
+interface BraUpdateAccountInput {
+    accountMask?: string;
+    cashBalance?: number;
+    currency?: string;
+    householdId?: string;
+    institution?: string;
+    name?: string;
+    status?: BraAccountStatus;
+    type?: BraAccountType;
+}
+interface BraCreateHoldingInput {
+    accountId: string;
+    symbol: string;
+    asOf?: string;
+    assetClass?: BraAssetClass;
+    costBasis?: number;
+    currency?: string;
+    lastPrice?: number;
+    name?: string;
+    portfolioId?: string;
+    quantity?: number;
+}
+interface BraUpdateHoldingInput {
+    asOf?: string;
+    assetClass?: BraAssetClass;
+    costBasis?: number;
+    lastPrice?: number;
+    name?: string;
+    portfolioId?: string;
+    quantity?: number;
+}
+interface BraCreateTransactionInput {
+    accountId: string;
+    tradeDate: string;
+    type: BraTransactionType;
+    amount?: number;
+    currency?: string;
+    fee?: number;
+    holdingId?: string;
+    notes?: string;
+    price?: number;
+    quantity?: number;
+    settleDate?: string;
+    symbol?: string;
+}
+interface BraModelAllocationInput {
+    assetClass: BraAssetClass;
+    targetPct: number;
+}
+interface BraCreateModelPortfolioInput {
+    name: string;
+    allocations?: BraModelAllocationInput[];
+    baseCurrency?: string;
+    description?: string;
+    riskProfile?: BraRiskProfile;
+}
+interface BraCreatePortfolioInput {
+    name: string;
+    baseCurrency?: string;
+    description?: string;
+    driftThresholdPct?: number;
+    householdId?: string;
+    modelPortfolioId?: string;
+    ownerId?: string;
+    tags?: string[];
+    targetAllocation?: Json;
+}
+interface BraUpdatePortfolioInput {
+    baseCurrency?: string;
+    description?: string;
+    driftThresholdPct?: number;
+    modelPortfolioId?: string;
+    name?: string;
+    status?: BraPortfolioStatus;
+    tags?: string[];
+    targetAllocation?: Json;
+}
+interface BraCreateGoalInput {
+    name: string;
+    targetAmount: number;
+    targetDate: string;
+    currency?: string;
+    householdId?: string;
+    monthlyContribution?: number;
+    notes?: string;
+    ownerId?: string;
+    priority?: number;
+    tags?: string[];
+    type?: BraGoalType;
+}
+interface BraUpdateGoalInput {
+    currency?: string;
+    monthlyContribution?: number;
+    name?: string;
+    notes?: string;
+    priority?: number;
+    status?: BraGoalStatus;
+    tags?: string[];
+    targetAmount?: number;
+    targetDate?: string;
+    type?: BraGoalType;
+}
+interface BraLinkGoalFundingInput {
+    accountId: string;
+    goalId: string;
+    allocationPct?: number;
+    fixedAmount?: number;
+}
+interface BraCreateInsightInput {
+    subjectId: string;
+    subjectType: string;
+    title: string;
+    type: BraInsightType;
+    detail?: string;
+    metrics?: Json;
+    ownerId?: string;
+    severity?: BraInsightSeverity;
+}
+interface BraCreateRebalanceProposalInput {
+    portfolioId: string;
+    driftPct?: number;
+    householdId?: string;
+    rationale?: string;
+    trades?: Json;
+}
+
+interface BrainyrichHouseholdsApi {
+    get(id: string): Promise<BraHousehold | null>;
+    list(pagination?: BraPaginationInput, status?: BraHouseholdStatus): Promise<BraHouseholdConnection>;
+    create(input: BraCreateHouseholdInput): Promise<BraHousehold>;
+    update(id: string, input: BraUpdateHouseholdInput): Promise<BraHousehold>;
+    archive(id: string): Promise<boolean>;
+}
+interface BrainyrichAccountsApi {
+    get(id: string): Promise<BraAccount | null>;
+    list(householdId?: string, pagination?: BraPaginationInput, status?: BraAccountStatus): Promise<BraAccountConnection>;
+    create(input: BraCreateAccountInput): Promise<BraAccount>;
+    update(id: string, input: BraUpdateAccountInput): Promise<BraAccount>;
+    archive(id: string): Promise<boolean>;
+}
+interface BrainyrichHoldingsApi {
+    list(accountId?: string, portfolioId?: string): Promise<BraHolding[]>;
+    create(input: BraCreateHoldingInput): Promise<BraHolding>;
+    update(id: string, input: BraUpdateHoldingInput): Promise<BraHolding>;
+    delete(id: string): Promise<boolean>;
+}
+interface BrainyrichTransactionsApi {
+    list(accountId?: string, pagination?: BraPaginationInput, type?: BraTransactionType): Promise<BraTransactionConnection>;
+    record(input: BraCreateTransactionInput): Promise<BraTransaction>;
+}
+interface BrainyrichPortfoliosApi {
+    get(id: string): Promise<BraPortfolio | null>;
+    list(householdId?: string, pagination?: BraPaginationInput, status?: BraPortfolioStatus): Promise<BraPortfolioConnection>;
+    create(input: BraCreatePortfolioInput): Promise<BraPortfolio>;
+    update(id: string, input: BraUpdatePortfolioInput): Promise<BraPortfolio>;
+    archive(id: string): Promise<boolean>;
+}
+interface BrainyrichModelPortfoliosApi {
+    get(id: string): Promise<BraModelPortfolio | null>;
+    list(): Promise<BraModelPortfolio[]>;
+    create(input: BraCreateModelPortfolioInput): Promise<BraModelPortfolio>;
+}
+interface BrainyrichGoalsApi {
+    get(id: string): Promise<BraGoal | null>;
+    list(householdId?: string, pagination?: BraPaginationInput, status?: BraGoalStatus): Promise<BraGoalConnection>;
+    create(input: BraCreateGoalInput): Promise<BraGoal>;
+    update(id: string, input: BraUpdateGoalInput): Promise<BraGoal>;
+    archive(id: string): Promise<boolean>;
+    recalcProjection(id: string, fundedAmount: number): Promise<BraGoal>;
+    listFundings(goalId: string): Promise<BraGoalFunding[]>;
+    linkFunding(input: BraLinkGoalFundingInput): Promise<BraGoalFunding>;
+    unlinkFunding(id: string): Promise<boolean>;
+}
+interface BrainyrichInsightsApi {
+    get(id: string): Promise<BraInsight | null>;
+    list(opts?: {
+        severity?: BraInsightSeverity;
+        status?: BraInsightStatus;
+        subjectId?: string;
+        subjectType?: string;
+        pagination?: BraPaginationInput;
+    }): Promise<BraInsightConnection>;
+    create(input: BraCreateInsightInput): Promise<BraInsight>;
+    acknowledge(id: string): Promise<BraInsight>;
+    dismiss(id: string): Promise<BraInsight>;
+    resolve(id: string): Promise<BraInsight>;
+}
+interface BrainyrichRebalancesApi {
+    list(householdId?: string, portfolioId?: string, status?: BraRebalanceStatus): Promise<BraRebalanceProposal[]>;
+    create(input: BraCreateRebalanceProposalInput): Promise<BraRebalanceProposal>;
+    transition(id: string, status: BraRebalanceStatus): Promise<BraRebalanceProposal>;
+}
+interface BrainyrichAnalyticsApi {
+    netWorthSummary(ownerId?: string): Promise<BraNetWorthSummary>;
+}
+interface BrainyrichSystemApi {
+    health(): Promise<string>;
+}
+interface BrainyrichApi {
+    households: BrainyrichHouseholdsApi;
+    accounts: BrainyrichAccountsApi;
+    holdings: BrainyrichHoldingsApi;
+    transactions: BrainyrichTransactionsApi;
+    portfolios: BrainyrichPortfoliosApi;
+    modelPortfolios: BrainyrichModelPortfoliosApi;
+    goals: BrainyrichGoalsApi;
+    insights: BrainyrichInsightsApi;
+    rebalances: BrainyrichRebalancesApi;
+    analytics: BrainyrichAnalyticsApi;
+    system: BrainyrichSystemApi;
+}
+
+declare const brainyrichModule: SdkModule<BrainyrichApi>;
+
+export { type BraAccount, type BraAccountConnection, type BraAccountStatus, type BraAccountType, type BraAssetClass, type BraCreateAccountInput, type BraCreateGoalInput, type BraCreateHoldingInput, type BraCreateHouseholdInput, type BraCreateInsightInput, type BraCreateModelPortfolioInput, type BraCreatePortfolioInput, type BraCreateRebalanceProposalInput, type BraCreateTransactionInput, type BraGoal, type BraGoalConnection, type BraGoalFunding, type BraGoalProjection, type BraGoalStatus, type BraGoalType, type BraHolding, type BraHousehold, type BraHouseholdConnection, type BraHouseholdStatus, type BraInsight, type BraInsightConnection, type BraInsightSeverity, type BraInsightStatus, type BraInsightType, type BraLinkGoalFundingInput, type BraModelAllocation, type BraModelAllocationInput, type BraModelPortfolio, type BraNetWorthByClass, type BraNetWorthSummary, type BraPageInfo, type BraPaginationInput, type BraPortfolio, type BraPortfolioConnection, type BraPortfolioStatus, type BraRebalanceProposal, type BraRebalanceStatus, type BraRiskProfile, type BraTransaction, type BraTransactionConnection, type BraTransactionType, type BraUpdateAccountInput, type BraUpdateGoalInput, type BraUpdateHoldingInput, type BraUpdateHouseholdInput, type BraUpdatePortfolioInput, type BrainyrichAccountsApi, type BrainyrichAnalyticsApi, type BrainyrichApi, type BrainyrichGoalsApi, type BrainyrichHoldingsApi, type BrainyrichHouseholdsApi, type BrainyrichInsightsApi, type BrainyrichModelPortfoliosApi, type BrainyrichPortfoliosApi, type BrainyrichRebalancesApi, type BrainyrichSystemApi, type BrainyrichTransactionsApi, brainyrichModule as default };