@lightsparkdev/lightspark-sdk 1.2.0 → 1.2.1

package/dist/{index-f040db9f.d.ts → index-5acc6526.d.ts}

@@ -279,26 +279,107 @@ declare enum TransactionType {
 
 /** This is an object representing a channel on the Lightning Network. You can retrieve this object to get detailed information on a specific Lightning Network channel. **/
 declare class Channel implements Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The local Lightspark node of the channel. **/
     readonly localNodeId: string;
+    /** The typename of the object **/
     readonly typename: string;
+    /** The transaction that funded the channel upon channel opening. **/
     readonly fundingTransactionId?: string | undefined;
+    /**
+     * The total amount of funds in this channel, including the channel balance on the local node, the
+     * channel balance on the remote node and the on-chain fees to close the channel.
+     **/
     readonly capacity?: CurrencyAmount | undefined;
+    /** The channel balance on the local node. **/
     readonly localBalance?: CurrencyAmount | undefined;
+    /** The channel balance on the local node that is currently allocated to in-progress payments. **/
     readonly localUnsettledBalance?: CurrencyAmount | undefined;
+    /** The channel balance on the remote node. **/
     readonly remoteBalance?: CurrencyAmount | undefined;
+    /** The channel balance on the remote node that is currently allocated to in-progress payments. **/
     readonly remoteUnsettledBalance?: CurrencyAmount | undefined;
+    /** The channel balance that is currently allocated to in-progress payments. **/
     readonly unsettledBalance?: CurrencyAmount | undefined;
+    /** The total balance in this channel, including the channel balance on both local and remote nodes. **/
     readonly totalBalance?: CurrencyAmount | undefined;
+    /** The current status of this channel. **/
     readonly status?: ChannelStatus | undefined;
+    /**
+     * The estimated time to wait for the channel's hash timelock contract to expire when force closing
+     * the channel. It is in unit of minutes.
+     **/
     readonly estimatedForceClosureWaitMinutes?: number | undefined;
+    /** The amount to be paid in fees for the current set of commitment transactions. **/
     readonly commitFee?: CurrencyAmount | undefined;
+    /** The fees charged for routing payments through this channel. **/
     readonly fees?: ChannelFees | undefined;
+    /** If known, the remote node of the channel. **/
     readonly remoteNodeId?: string | undefined;
+    /**
+     * The unique identifier of the channel on Lightning Network, which is the location in the chain that
+     * the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
+     **/
     readonly shortChannelId?: string | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, localNodeId: string, typename: string, fundingTransactionId?: string | undefined, capacity?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, localUnsettledBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, remoteUnsettledBalance?: CurrencyAmount | undefined, unsettledBalance?: CurrencyAmount | undefined, totalBalance?: CurrencyAmount | undefined, status?: ChannelStatus | undefined, estimatedForceClosureWaitMinutes?: number | undefined, commitFee?: CurrencyAmount | undefined, fees?: ChannelFees | undefined, remoteNodeId?: string | undefined, shortChannelId?: string | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The local Lightspark node of the channel. **/
+    localNodeId: string, 
+    /** The typename of the object **/
+    typename: string, 
+    /** The transaction that funded the channel upon channel opening. **/
+    fundingTransactionId?: string | undefined, 
+    /**
+     * The total amount of funds in this channel, including the channel balance on the local node, the
+     * channel balance on the remote node and the on-chain fees to close the channel.
+     **/
+    capacity?: CurrencyAmount | undefined, 
+    /** The channel balance on the local node. **/
+    localBalance?: CurrencyAmount | undefined, 
+    /** The channel balance on the local node that is currently allocated to in-progress payments. **/
+    localUnsettledBalance?: CurrencyAmount | undefined, 
+    /** The channel balance on the remote node. **/
+    remoteBalance?: CurrencyAmount | undefined, 
+    /** The channel balance on the remote node that is currently allocated to in-progress payments. **/
+    remoteUnsettledBalance?: CurrencyAmount | undefined, 
+    /** The channel balance that is currently allocated to in-progress payments. **/
+    unsettledBalance?: CurrencyAmount | undefined, 
+    /** The total balance in this channel, including the channel balance on both local and remote nodes. **/
+    totalBalance?: CurrencyAmount | undefined, 
+    /** The current status of this channel. **/
+    status?: ChannelStatus | undefined, 
+    /**
+     * The estimated time to wait for the channel's hash timelock contract to expire when force closing
+     * the channel. It is in unit of minutes.
+     **/
+    estimatedForceClosureWaitMinutes?: number | undefined, 
+    /** The amount to be paid in fees for the current set of commitment transactions. **/
+    commitFee?: CurrencyAmount | undefined, 
+    /** The fees charged for routing payments through this channel. **/
+    fees?: ChannelFees | undefined, 
+    /** If known, the remote node of the channel. **/
+    remoteNodeId?: string | undefined, 
+    /**
+     * The unique identifier of the channel on Lightning Network, which is the location in the chain that
+     * the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
+     **/
+    shortChannelId?: string | undefined);
     getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
     getTransactions(client: LightsparkClient, types?: TransactionType[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<ChannelToTransactionsConnection>;
     static getChannelQuery(id: string): Query<Channel>;
@@ -332,9 +413,21 @@ declare class Channel implements Entity {
 }
 
 declare class AccountToChannelsConnection {
+    /**
+     * The total count of objects in this connection, using the current filters. It is different from the
+     * number of objects returned in the current page (in the `entities` field).
+     **/
     readonly count: number;
+    /** The channels for the current page of this connection. **/
     readonly entities: Channel[];
-    constructor(count: number, entities: Channel[]);
+    constructor(
+    /**
+     * The total count of objects in this connection, using the current filters. It is different from the
+     * number of objects returned in the current page (in the `entities` field).
+     **/
+    count: number, 
+    /** The channels for the current page of this connection. **/
+    entities: Channel[]);
     toJson(): {
         account_to_channels_connection_count: number;
         account_to_channels_connection_entities: {
@@ -741,16 +834,49 @@ interface WalletToTransactionsConnection {
 
 /** This object represents a Lightspark Wallet, tied to your Lightspark account. Wallets can be used to send or receive funds over the Lightning Network. You can retrieve this object to receive information about a specific wallet tied to your Lightspark account. **/
 declare class Wallet implements LightsparkNodeOwner, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The unique identifier of this wallet, as provided by the Lightspark Customer during login. **/
     readonly thirdPartyIdentifier: string;
+    /** The status of this wallet. **/
     readonly status: WalletStatus;
+    /** The typename of the object **/
     readonly typename: string;
+    /** The date and time when the wallet user last logged in. **/
     readonly lastLoginAt?: string | undefined;
+    /** The balances that describe the funds in this wallet. **/
     readonly balances?: Balances | undefined;
+    /** The account this wallet belongs to. **/
     readonly accountId?: string | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, thirdPartyIdentifier: string, status: WalletStatus, typename: string, lastLoginAt?: string | undefined, balances?: Balances | undefined, accountId?: string | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The unique identifier of this wallet, as provided by the Lightspark Customer during login. **/
+    thirdPartyIdentifier: string, 
+    /** The status of this wallet. **/
+    status: WalletStatus, 
+    /** The typename of the object **/
+    typename: string, 
+    /** The date and time when the wallet user last logged in. **/
+    lastLoginAt?: string | undefined, 
+    /** The balances that describe the funds in this wallet. **/
+    balances?: Balances | undefined, 
+    /** The account this wallet belongs to. **/
+    accountId?: string | undefined);
     getTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined, statuses?: TransactionStatus[] | undefined, types?: TransactionType[] | undefined): Promise<WalletToTransactionsConnection>;
     getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<WalletToPaymentRequestsConnection>;
     getTotalAmountReceived(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
@@ -824,12 +950,33 @@ interface TransactionFailures {
 
 /** This is an object representing the connected Lightspark account. You can retrieve this object to see your account information and objects tied to your account. **/
 declare class Account implements LightsparkNodeOwner, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The typename of the object **/
     readonly typename: string;
+    /** The name of this account. **/
     readonly name?: string | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, typename: string, name?: string | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The typename of the object **/
+    typename: string, 
+    /** The name of this account. **/
+    name?: string | undefined);
     getApiTokens(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<AccountToApiTokensConnection>;
     getBlockchainBalance(client: LightsparkClient, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<BlockchainBalance | null>;
     getConductivity(client: LightsparkClient, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<number>;
@@ -957,18 +1104,63 @@ interface PostTransactionData {
 
 /** This object represents any payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific payment received by a Lightspark node. **/
 declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when this transaction was initiated. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The current status of this transaction. **/
     readonly status: TransactionStatus;
+    /** The amount of money involved in this transaction. **/
     readonly amount: CurrencyAmount;
+    /** The recipient Lightspark node this payment was sent to. **/
     readonly destinationId: string;
+    /** The typename of the object **/
     readonly typename: string;
+    /** The date and time when this transaction was completed or failed. **/
     readonly resolvedAt?: string | undefined;
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
     readonly transactionHash?: string | undefined;
+    /**
+     * The optional payment request for this incoming payment, which will be null if the payment is sent
+     * through keysend.
+     **/
     readonly paymentRequestId?: string | undefined;
+    /** The post transaction data which can be used in KYT payment registration. **/
     readonly umaPostTransactionData?: PostTransactionData[] | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, destinationId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, paymentRequestId?: string | undefined, umaPostTransactionData?: PostTransactionData[] | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when this transaction was initiated. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The current status of this transaction. **/
+    status: TransactionStatus, 
+    /** The amount of money involved in this transaction. **/
+    amount: CurrencyAmount, 
+    /** The recipient Lightspark node this payment was sent to. **/
+    destinationId: string, 
+    /** The typename of the object **/
+    typename: string, 
+    /** The date and time when this transaction was completed or failed. **/
+    resolvedAt?: string | undefined, 
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+    transactionHash?: string | undefined, 
+    /**
+     * The optional payment request for this incoming payment, which will be null if the payment is sent
+     * through keysend.
+     **/
+    paymentRequestId?: string | undefined, 
+    /** The post transaction data which can be used in KYT payment registration. **/
+    umaPostTransactionData?: PostTransactionData[] | undefined);
     getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
     static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
     toJson(): {
@@ -1196,19 +1388,83 @@ interface OutgoingPaymentAttemptToHopsConnection {
 
 /** This object represents an attempted Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment attempt sent from your Lightspark Node on the Lightning Network, including any potential reasons the payment may have failed. **/
 declare class OutgoingPaymentAttempt implements Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the attempt was initiated. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The status of an outgoing payment attempt. **/
     readonly status: OutgoingPaymentAttemptStatus;
+    /** The outgoing payment for this attempt. **/
     readonly outgoingPaymentId: string;
+    /** The typename of the object **/
     readonly typename: string;
+    /** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
     readonly failureCode?: HtlcAttemptFailureCode | undefined;
+    /**
+     * If the payment attempt failed, then this contains the index of the hop at which the problem
+     * occurred.
+     **/
     readonly failureSourceIndex?: number | undefined;
+    /** The time the outgoing payment attempt failed or succeeded. **/
     readonly resolvedAt?: string | undefined;
+    /**
+     * The total amount of funds required to complete a payment over this route. This value includes the
+     * cumulative fees for each hop. As a result, the attempt extended to the first-hop in the route will
+     * need to have at least this much value, otherwise the route will fail at an intermediate node due to
+     * an insufficient amount.
+     **/
     readonly amount?: CurrencyAmount | undefined;
+    /**
+     * The sum of the fees paid at each hop within the route of this attempt. In the case of a one-hop
+     * payment, this value will be zero as we don't need to pay a fee to ourselves.
+     **/
     readonly fees?: CurrencyAmount | undefined;
+    /** The channel snapshot at the time the outgoing payment attempt was made. **/
     readonly channelSnapshot?: ChannelSnapshot | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, status: OutgoingPaymentAttemptStatus, outgoingPaymentId: string, typename: string, failureCode?: HtlcAttemptFailureCode | undefined, failureSourceIndex?: number | undefined, resolvedAt?: string | undefined, amount?: CurrencyAmount | undefined, fees?: CurrencyAmount | undefined, channelSnapshot?: ChannelSnapshot | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the attempt was initiated. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The status of an outgoing payment attempt. **/
+    status: OutgoingPaymentAttemptStatus, 
+    /** The outgoing payment for this attempt. **/
+    outgoingPaymentId: string, 
+    /** The typename of the object **/
+    typename: string, 
+    /** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
+    failureCode?: HtlcAttemptFailureCode | undefined, 
+    /**
+     * If the payment attempt failed, then this contains the index of the hop at which the problem
+     * occurred.
+     **/
+    failureSourceIndex?: number | undefined, 
+    /** The time the outgoing payment attempt failed or succeeded. **/
+    resolvedAt?: string | undefined, 
+    /**
+     * The total amount of funds required to complete a payment over this route. This value includes the
+     * cumulative fees for each hop. As a result, the attempt extended to the first-hop in the route will
+     * need to have at least this much value, otherwise the route will fail at an intermediate node due to
+     * an insufficient amount.
+     **/
+    amount?: CurrencyAmount | undefined, 
+    /**
+     * The sum of the fees paid at each hop within the route of this attempt. In the case of a one-hop
+     * payment, this value will be zero as we don't need to pay a fee to ourselves.
+     **/
+    fees?: CurrencyAmount | undefined, 
+    /** The channel snapshot at the time the outgoing payment attempt was made. **/
+    channelSnapshot?: ChannelSnapshot | undefined);
     getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
     static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
     toJson(): {
@@ -1250,23 +1506,77 @@ interface RichText {
 
 /** This object represents a Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment sent from your Lightspark Node on the Lightning Network. **/
 declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when this transaction was initiated. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The current status of this transaction. **/
     readonly status: TransactionStatus;
+    /** The amount of money involved in this transaction. **/
     readonly amount: CurrencyAmount;
+    /** The Lightspark node this payment originated from. **/
     readonly originId: string;
+    /** The typename of the object **/
     readonly typename: string;
+    /** The date and time when this transaction was completed or failed. **/
     readonly resolvedAt?: string | undefined;
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
     readonly transactionHash?: string | undefined;
+    /** If known, the final recipient node this payment was sent to. **/
     readonly destinationId?: string | undefined;
+    /** The fees paid by the sender node to send the payment. **/
     readonly fees?: CurrencyAmount | undefined;
+    /** The data of the payment request that was paid by this transaction, if known. **/
     readonly paymentRequestData?: PaymentRequestData | undefined;
+    /** If applicable, the reason why the payment failed. **/
     readonly failureReason?: PaymentFailureReason | undefined;
+    /** If applicable, user-facing error message describing why the payment failed. **/
     readonly failureMessage?: RichText | undefined;
+    /** The post transaction data which can be used in KYT payment registration. **/
     readonly umaPostTransactionData?: PostTransactionData[] | undefined;
+    /** The preimage of the payment. **/
     readonly paymentPreimage?: string | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, originId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, destinationId?: string | undefined, fees?: CurrencyAmount | undefined, paymentRequestData?: PaymentRequestData | undefined, failureReason?: PaymentFailureReason | undefined, failureMessage?: RichText | undefined, umaPostTransactionData?: PostTransactionData[] | undefined, paymentPreimage?: string | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when this transaction was initiated. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The current status of this transaction. **/
+    status: TransactionStatus, 
+    /** The amount of money involved in this transaction. **/
+    amount: CurrencyAmount, 
+    /** The Lightspark node this payment originated from. **/
+    originId: string, 
+    /** The typename of the object **/
+    typename: string, 
+    /** The date and time when this transaction was completed or failed. **/
+    resolvedAt?: string | undefined, 
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+    transactionHash?: string | undefined, 
+    /** If known, the final recipient node this payment was sent to. **/
+    destinationId?: string | undefined, 
+    /** The fees paid by the sender node to send the payment. **/
+    fees?: CurrencyAmount | undefined, 
+    /** The data of the payment request that was paid by this transaction, if known. **/
+    paymentRequestData?: PaymentRequestData | undefined, 
+    /** If applicable, the reason why the payment failed. **/
+    failureReason?: PaymentFailureReason | undefined, 
+    /** If applicable, user-facing error message describing why the payment failed. **/
+    failureMessage?: RichText | undefined, 
+    /** The post transaction data which can be used in KYT payment registration. **/
+    umaPostTransactionData?: PostTransactionData[] | undefined, 
+    /** The preimage of the payment. **/
+    paymentPreimage?: string | undefined);
     getAttempts(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentToAttemptsConnection>;
     static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
     toJson(): {
@@ -1478,18 +1788,63 @@ interface WithdrawalRequestToChannelOpeningTransactionsConnection {
 
 /** This object represents a request made for an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any withdrawal request made from your Lightspark account. **/
 declare class WithdrawalRequest implements Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The amount of money that should be withdrawn in this request. **/
     readonly amount: CurrencyAmount;
+    /** The bitcoin address where the funds should be sent. **/
     readonly bitcoinAddress: string;
+    /** The strategy that should be used to withdraw the funds from the account. **/
     readonly withdrawalMode: WithdrawalMode;
+    /** The current status of this withdrawal request. **/
     readonly status: WithdrawalRequestStatus;
+    /** The typename of the object **/
     readonly typename: string;
+    /**
+     * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount
+     * for the withdrawal.
+     **/
     readonly estimatedAmount?: CurrencyAmount | undefined;
+    /** The time at which this request was completed. **/
     readonly completedAt?: string | undefined;
+    /** The withdrawal transaction that has been generated by this request. **/
     readonly withdrawalId?: string | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, amount: CurrencyAmount, bitcoinAddress: string, withdrawalMode: WithdrawalMode, status: WithdrawalRequestStatus, typename: string, estimatedAmount?: CurrencyAmount | undefined, completedAt?: string | undefined, withdrawalId?: string | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The amount of money that should be withdrawn in this request. **/
+    amount: CurrencyAmount, 
+    /** The bitcoin address where the funds should be sent. **/
+    bitcoinAddress: string, 
+    /** The strategy that should be used to withdraw the funds from the account. **/
+    withdrawalMode: WithdrawalMode, 
+    /** The current status of this withdrawal request. **/
+    status: WithdrawalRequestStatus, 
+    /** The typename of the object **/
+    typename: string, 
+    /**
+     * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount
+     * for the withdrawal.
+     **/
+    estimatedAmount?: CurrencyAmount | undefined, 
+    /** The time at which this request was completed. **/
+    completedAt?: string | undefined, 
+    /** The withdrawal transaction that has been generated by this request. **/
+    withdrawalId?: string | undefined);
     getChannelClosingTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelClosingTransactionsConnection>;
     getChannelOpeningTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelOpeningTransactionsConnection>;
     static getWithdrawalRequestQuery(id: string): Query<WithdrawalRequest>;
@@ -1565,7 +1920,8 @@ declare class LightsparkClient {
     /**
      * Constructs a new LightsparkClient.
      *
-     * @param authProvider The auth provider to use for authentication. Defaults to a stub auth provider. For server-side
+     * @param authProvider The auth provider to use for authentication. Defaults to a stub auth provider.
+     * For server-side
      *     use, you should use the `AccountTokenAuthProvider`.
      * @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
      * @param cryptoImpl The crypto implementation to use. Defaults to web and node compatible crypto.
@@ -1594,7 +1950,7 @@ declare class LightsparkClient {
      *
      * @param authProvider
      */
-    setAuthProvider(authProvider: AuthProvider): Promise<void>;
+    setAuthProvider(authProvider: AuthProvider): void;
     /**
      * @returns Whether or not the client is authorized. This is useful for determining if the user is logged in or not.
      */
@@ -1777,7 +2133,7 @@ declare class LightsparkClient {
      * @param transactionId The ID of the transaction to wait for
      * @param pollTimeoutSecs The timeout in seconds that we will wait before throwing an exception
      */
-    waitForTransactionComplete(transactionId: string, pollTimeoutSecs?: number): Promise<Transaction>;
+    waitForTransactionComplete<T = Transaction>(transactionId: string, pollTimeoutSecs?: number): Promise<T>;
     /**
      * Sends a payment directly to a node on the Lightning Network through the public key of the node without an invoice.
      *
@@ -2092,17 +2448,83 @@ interface FundNodeOutput {
 
 /** This object represents a node that exists on the Lightning Network, including nodes not managed by Lightspark. You can retrieve this object to get publicly available information about any node on the Lightning Network. **/
 declare class GraphNode implements Node, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The Bitcoin Network this node is deployed in. **/
     readonly bitcoinNetwork: BitcoinNetwork;
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     readonly displayName: string;
+    /** The typename of the object **/
     readonly typename: string;
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
     readonly alias?: string | undefined;
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
     readonly color?: string | undefined;
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
     readonly conductivity?: number | undefined;
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
     readonly publicKey?: string | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The Bitcoin Network this node is deployed in. **/
+    bitcoinNetwork: BitcoinNetwork, 
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
+    displayName: string, 
+    /** The typename of the object **/
+    typename: string, 
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
+    alias?: string | undefined, 
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
+    color?: string | undefined, 
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
+    conductivity?: number | undefined, 
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
+    publicKey?: string | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     static getGraphNodeQuery(id: string): Query<GraphNode>;
     toJson(): {
@@ -2159,27 +2581,169 @@ interface Secret {
 
 /** This is a Lightspark node with OSK. **/
 declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The Bitcoin Network this node is deployed in. **/
     readonly bitcoinNetwork: BitcoinNetwork;
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     readonly displayName: string;
+    /** The owner of this LightsparkNode. **/
     readonly ownerId: string;
+    /**
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
+     **/
     readonly umaPrescreeningUtxos: string[];
+    /** The typename of the object **/
     readonly typename: string;
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
     readonly alias?: string | undefined;
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
     readonly color?: string | undefined;
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
     readonly conductivity?: number | undefined;
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
     readonly publicKey?: string | undefined;
+    /** The current status of this node. **/
     readonly status?: LightsparkNodeStatus | undefined;
+    /**
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly totalBalance?: CurrencyAmount | undefined;
+    /**
+     * The total sum of the channel balances (online and offline) on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly totalLocalBalance?: CurrencyAmount | undefined;
+    /**
+     * The sum of the channel balances (online only) that are available to send on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly localBalance?: CurrencyAmount | undefined;
+    /**
+     * The sum of the channel balances that are available to receive on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly remoteBalance?: CurrencyAmount | undefined;
+    /**
+     * The details of the balance of this node on the Bitcoin Network.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly blockchainBalance?: BlockchainBalance | undefined;
+    /** The balances that describe the funds in this node. **/
     readonly balances?: Balances | undefined;
+    /** The private key client is using to sign a GraphQL request which will be verified at server side. **/
     readonly encryptedSigningPrivateKey?: Secret | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, balances?: Balances | undefined, encryptedSigningPrivateKey?: Secret | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The Bitcoin Network this node is deployed in. **/
+    bitcoinNetwork: BitcoinNetwork, 
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
+    displayName: string, 
+    /** The owner of this LightsparkNode. **/
+    ownerId: string, 
+    /**
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
+     **/
+    umaPrescreeningUtxos: string[], 
+    /** The typename of the object **/
+    typename: string, 
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
+    alias?: string | undefined, 
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
+    color?: string | undefined, 
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
+    conductivity?: number | undefined, 
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
+    publicKey?: string | undefined, 
+    /** The current status of this node. **/
+    status?: LightsparkNodeStatus | undefined, 
+    /**
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    totalBalance?: CurrencyAmount | undefined, 
+    /**
+     * The total sum of the channel balances (online and offline) on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    totalLocalBalance?: CurrencyAmount | undefined, 
+    /**
+     * The sum of the channel balances (online only) that are available to send on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    localBalance?: CurrencyAmount | undefined, 
+    /**
+     * The sum of the channel balances that are available to receive on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    remoteBalance?: CurrencyAmount | undefined, 
+    /**
+     * The details of the balance of this node on the Bitcoin Network.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    blockchainBalance?: BlockchainBalance | undefined, 
+    /** The balances that describe the funds in this node. **/
+    balances?: Balances | undefined, 
+    /** The private key client is using to sign a GraphQL request which will be verified at server side. **/
+    encryptedSigningPrivateKey?: Secret | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeWithOSKQuery(id: string): Query<LightsparkNodeWithOSK>;
@@ -2211,26 +2775,165 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
 
 /** This is a Lightspark node with remote signing. **/
 declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     readonly id: string;
+    /** The date and time when the entity was first created. **/
     readonly createdAt: string;
+    /** The date and time when the entity was last updated. **/
     readonly updatedAt: string;
+    /** The Bitcoin Network this node is deployed in. **/
     readonly bitcoinNetwork: BitcoinNetwork;
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     readonly displayName: string;
+    /** The owner of this LightsparkNode. **/
     readonly ownerId: string;
+    /**
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
+     **/
     readonly umaPrescreeningUtxos: string[];
+    /** The typename of the object **/
     readonly typename: string;
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
     readonly alias?: string | undefined;
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
     readonly color?: string | undefined;
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
     readonly conductivity?: number | undefined;
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
     readonly publicKey?: string | undefined;
+    /** The current status of this node. **/
     readonly status?: LightsparkNodeStatus | undefined;
+    /**
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly totalBalance?: CurrencyAmount | undefined;
+    /**
+     * The total sum of the channel balances (online and offline) on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly totalLocalBalance?: CurrencyAmount | undefined;
+    /**
+     * The sum of the channel balances (online only) that are available to send on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly localBalance?: CurrencyAmount | undefined;
+    /**
+     * The sum of the channel balances that are available to receive on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly remoteBalance?: CurrencyAmount | undefined;
+    /**
+     * The details of the balance of this node on the Bitcoin Network.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     readonly blockchainBalance?: BlockchainBalance | undefined;
+    /** The balances that describe the funds in this node. **/
     readonly balances?: Balances | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, balances?: Balances | undefined);
+    constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string, 
+    /** The date and time when the entity was first created. **/
+    createdAt: string, 
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string, 
+    /** The Bitcoin Network this node is deployed in. **/
+    bitcoinNetwork: BitcoinNetwork, 
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
+    displayName: string, 
+    /** The owner of this LightsparkNode. **/
+    ownerId: string, 
+    /**
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
+     **/
+    umaPrescreeningUtxos: string[], 
+    /** The typename of the object **/
+    typename: string, 
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
+    alias?: string | undefined, 
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
+    color?: string | undefined, 
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
+    conductivity?: number | undefined, 
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
+    publicKey?: string | undefined, 
+    /** The current status of this node. **/
+    status?: LightsparkNodeStatus | undefined, 
+    /**
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    totalBalance?: CurrencyAmount | undefined, 
+    /**
+     * The total sum of the channel balances (online and offline) on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    totalLocalBalance?: CurrencyAmount | undefined, 
+    /**
+     * The sum of the channel balances (online only) that are available to send on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    localBalance?: CurrencyAmount | undefined, 
+    /**
+     * The sum of the channel balances that are available to receive on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    remoteBalance?: CurrencyAmount | undefined, 
+    /**
+     * The details of the balance of this node on the Bitcoin Network.
+     *
+     * @deprecated Use `balances` instead.
+     **/
+    blockchainBalance?: BlockchainBalance | undefined, 
+    /** The balances that describe the funds in this node. **/
+    balances?: Balances | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeWithRemoteSigningQuery(id: string): Query<LightsparkNodeWithRemoteSigning>;