@spritz-finance/service-client 0.8.4 → 0.8.6

package/lib/payouts/payoutsServiceClient.d.ts

@@ -1,5 +1,5 @@
 export * as PayoutsClient from "./payoutsServiceClient";
-import { CryptoPayout, CryptoPayoutInput } from "./types";
+import { CryptoPayout, CryptoPayoutInput, TreasuryBalances } from "./types";
 export declare function requestCryptoPayout({ userId, type, network, amountFiat, referenceId, toAddress, tokenSymbol, currencyFiat, fromDispatchWallet, }: CryptoPayoutInput): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<CryptoPayout>>;
 export declare function getPayoutFromHash({ userId, transactionHash, }: {
     userId?: string;
@@ -22,3 +22,4 @@ export declare function submit7702Message(input: {
     to: `0x${string}`;
     chainId: number;
 }): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<string>>;
+export declare function getTreasuryBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<TreasuryBalances>>;

package/lib/payouts/payoutsServiceClient.js

@@ -38,6 +38,7 @@ exports.requestCryptoPayout = requestCryptoPayout;
 exports.getPayoutFromHash = getPayoutFromHash;
 exports.requestWithdrawlSignature = requestWithdrawlSignature;
 exports.submit7702Message = submit7702Message;
+exports.getTreasuryBalances = getTreasuryBalances;
 exports.PayoutsClient = __importStar(require("./payoutsServiceClient"));
 const serviceClient_1 = require("../serviceClient");
 const PAYOUTS_ENDPOINT = "/bridgebot";
@@ -74,3 +75,11 @@ async function submit7702Message(input) {
         .post(`${PAYOUTS_ENDPOINT}/signers/7702`, input)
         .then((res) => res.data);
 }
+// Served by bridgebot's Hono /api surface; reached through the same gateway
+// host via the /v2/bridgebot base path (the bare /bridgebot base path maps to
+// bridgebot's legacy REST API, which does not carry this route).
+async function getTreasuryBalances() {
+    return serviceClient_1.baseClient
+        .get(`/v2${PAYOUTS_ENDPOINT}/api/treasury/balances`)
+        .then((res) => res.data);
+}

package/lib/payouts/types.d.ts

@@ -32,3 +32,36 @@ export type CryptoPayout = {
     createdAt: string;
     updatedAt: string;
 };
+export type TreasuryWalletBalance = {
+    payoutType: "BRIDGE_TRANSFER" | "RAIN_CARD_DEPOSIT" | "ONRAMP_PURCHASE";
+    network: string;
+    address: string;
+    tokenSymbol: string;
+    currentBalanceUsd: string;
+    reservedUsd: string;
+    availableUsd: string;
+    floatTargetUsd: string;
+    errored: boolean;
+};
+export type TreasuryQueueSummary = {
+    queuedUsd: string;
+    queuedCount: number;
+    processingUsd: string;
+    processingCount: number;
+    failedUsd: string;
+    failedCount: number;
+    totalOwedUsd: string;
+    totalOwedCount: number;
+};
+export type TreasuryBalances = {
+    asOf: string;
+    wallets: TreasuryWalletBalance[];
+    /** All undelivered payouts across payout types. */
+    queue: TreasuryQueueSummary;
+    /**
+     * Per-payout-type breakdown — consumers tracking one provider's wallet
+     * (e.g. the Rain dispatch float) must read their own type here, not the
+     * combined queue.
+     */
+    queueByType: Partial<Record<TreasuryWalletBalance["payoutType"], TreasuryQueueSummary>>;
+};

package/lib/platform/platformServiceClient.d.ts

@@ -1,8 +1,13 @@
 export * as PlatformClient from "./platformServiceClient";
-import { IssuePayoutData, IssuePayoutRequest, MTBalancesData, SendPaymentData, SendPaymentRequest, TabapayBalancesResponse, TabapayFundingRequirementResponse, ValidateBillData, ValidateBillRequest } from "./types";
+import { IssuePayoutData, IssuePayoutRequest, MTBalancesData, PlaidTreasuryBalancesData, SendPaymentData, SendPaymentRequest, TabapayBalancesResponse, TabapayFundingRequirementResponse, ValidateBillData, ValidateBillRequest } from "./types";
 export declare function validateBill(request: ValidateBillRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<ValidateBillData>>;
 export declare function tabapayBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<TabapayBalancesResponse>>;
 export declare function tabapayFundingRequirement(currency?: string): Promise<TabapayFundingRequirementResponse>;
 export declare function issuePayout(request: IssuePayoutRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<IssuePayoutData>>;
 export declare function sendPayment(request: SendPaymentRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<SendPaymentData>>;
 export declare function modernTreasuryBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<MTBalancesData>>;
+/**
+ * Balances for company bank accounts linked via Plaid (e.g. Chase), served
+ * from the platform's snapshot cache and refreshed at most every few hours.
+ */
+export declare function plaidTreasuryBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<PlaidTreasuryBalancesData>>;

package/lib/platform/platformServiceClient.js

@@ -43,6 +43,7 @@ exports.tabapayFundingRequirement = tabapayFundingRequirement;
 exports.issuePayout = issuePayout;
 exports.sendPayment = sendPayment;
 exports.modernTreasuryBalances = modernTreasuryBalances;
+exports.plaidTreasuryBalances = plaidTreasuryBalances;
 exports.PlatformClient = __importStar(require("./platformServiceClient"));
 const axios_1 = __importDefault(require("axios"));
 // @ts-expect-error no type declarations for axios-token-interceptor
@@ -93,3 +94,13 @@ async function modernTreasuryBalances() {
         .get(`${MT_ENDPOINT}/balances`)
         .then((res) => res.data);
 }
+const PLAID_TREASURY_ENDPOINT = "/v1/plaid-treasury";
+/**
+ * Balances for company bank accounts linked via Plaid (e.g. Chase), served
+ * from the platform's snapshot cache and refreshed at most every few hours.
+ */
+async function plaidTreasuryBalances() {
+    return platformClient
+        .get(`${PLAID_TREASURY_ENDPOINT}/balances`)
+        .then((res) => res.data);
+}

package/lib/platform/types.d.ts

@@ -76,3 +76,27 @@ export interface MTAccount {
 export interface MTBalancesData {
     accounts: MTAccount[];
 }
+export interface PlaidTreasuryAccountBalance {
+    /** Platform plaid_accounts record id. */
+    id: string;
+    plaidAccountId: string;
+    name: string;
+    mask: string | null;
+    institutionName: string | null;
+    type: string;
+    subtype: string | null;
+    /** Available balance as decimal dollars (e.g. "1234.56"), null if Plaid omits it. */
+    available: string | null;
+    /** Current balance as decimal dollars (e.g. "1234.56"), null if Plaid omits it. */
+    current: string | null;
+    currency: string | null;
+    /** ISO timestamp of when the balance was fetched from Plaid. */
+    asOf: string;
+    /** True when served from the platform's snapshot cache instead of a live Plaid call. */
+    cached: boolean;
+    /** True when the snapshot is older than the cache TTL because the Plaid refresh failed. */
+    stale: boolean;
+}
+export interface PlaidTreasuryBalancesData {
+    accounts: PlaidTreasuryAccountBalance[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spritz-finance/service-client",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "gitHead": "06f8e96b7b38c34df26a38da329331940675e4f8",
   "description": "Service client",
   "license": "ISC",