@lightsparkdev/lightspark-sdk 0.4.8 → 0.4.10

package/dist/{index-adeff42d.d.ts → index-3ffe9e7b.d.ts}

@@ -1,6 +1,7 @@
 import { Maybe, Query, AuthProvider, CryptoInterface, KeyOrAliasType } from '@lightsparkdev/core';
 import Observable from 'zen-observable';
 
+/** This enum identifies the unit of currency associated with a CurrencyAmount. **/
 declare enum CurrencyUnit {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -23,7 +24,7 @@ declare enum CurrencyUnit {
     MILLIBITCOIN = "MILLIBITCOIN"
 }
 
-/** Represents the value and unit for an amount of currency. **/
+/** This object represents the value and unit for an amount of currency. **/
 type CurrencyAmount = {
     /** The original numeric value for this CurrencyAmount. **/
     originalValue: number;
@@ -43,6 +44,7 @@ type CurrencyAmount = {
     preferredCurrencyValueApprox: number;
 };
 
+/** This is an enum of potential purposes set by a user for a Lightspark node. **/
 declare enum LightsparkNodePurpose {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -72,7 +74,7 @@ declare enum LightsparkNodeStatus {
     FAILED_TO_DEPLOY = "FAILED_TO_DEPLOY"
 }
 
-/** An enum that enumerates all possible types of addresses of a node on the Lightning Network. **/
+/** This is an enum of the potential types of addresses that a node on the Lightning Network can have. **/
 declare enum NodeAddressType {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -118,7 +120,7 @@ type AccountDashboard = {
     remoteBalance: Maybe<CurrencyAmount>;
 };
 
-/** This interface is used by all the entities in the Lightspark systems. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID. **/
+/** This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID. **/
 type Entity = {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -133,6 +135,7 @@ type Entity = {
     typename: string;
 };
 
+/** This is an enum of the potential permissions that a Lightspark user can have in regards to account management. **/
 declare enum Permission {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -155,6 +158,7 @@ declare enum Permission {
     ACCOUNT_MANAGE = "ACCOUNT_MANAGE"
 }
 
+/** This is an object representing a Lightspark API token, that can be used to authenticate this account when making API calls or using our SDKs. See the “Authentication” section of our API docs for more details on its usage. **/
 type ApiToken = Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -182,6 +186,7 @@ type ApiToken = Entity & {
 };
 declare const getApiTokenQuery: (id: string) => Query<ApiToken>;
 
+/** This is an object representing information about a page returned by the Lightspark API. For more information, please see the “Pagination” section of our API docs for more information about its usage. **/
 type PageInfo = {
     hasNextPage?: boolean;
     hasPreviousPage?: boolean;
@@ -189,23 +194,39 @@ type PageInfo = {
     endCursor?: string;
 };
 
-type AccountToApiTokensConnection = {
+type Connection = {
+    /**
+     * 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;
     /** An object that holds pagination information about the objects in this connection. **/
     pageInfo: PageInfo;
+    /** The typename of the object **/
+    typename: string;
+};
+
+type AccountToApiTokensConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The API tokens for the current page of this connection. **/
     entities: ApiToken[];
+    /** The typename of the object **/
+    typename: string;
 };
 
+/** This represents the fee policies set for a channel on the Lightning Network. **/
 type ChannelFees = {
     baseFee?: CurrencyAmount;
     feeRatePerMil?: number;
 };
 
+/** This is an enum representing the status of a channel on the Lightning Network. **/
 declare enum ChannelStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -251,6 +272,7 @@ type ChannelToTransactionsConnection = {
     totalFees?: CurrencyAmount;
 };
 
+/** This is an enum of the potential types of transactions that can be associated with your Lightspark Node. **/
 declare enum TransactionType {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -279,7 +301,7 @@ declare enum TransactionType {
     ROUTE = "ROUTE"
 }
 
-/** An object that represents a payment channel between two nodes in the Lightning Network. **/
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -312,6 +334,7 @@ declare class AccountToChannelsConnection {
     constructor(count: number, entities: Channel[]);
 }
 
+/** This is an enum identifying a particular Bitcoin Network. **/
 declare enum BitcoinNetwork {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -324,11 +347,11 @@ declare enum BitcoinNetwork {
     REGTEST = "REGTEST",
     /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
     SIGNET = "SIGNET",
-    /** A test version of the Bitcoin Blockchain, publically available. **/
+    /** A test version of the Bitcoin Blockchain, publicly available. **/
     TESTNET = "TESTNET"
 }
 
-/** This object provides a detailed breakdown of a `LightsparkNode`'s current balance on the Bitcoin Network. **/
+/** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
 type BlockchainBalance = {
     /** The total wallet balance, including unconfirmed UTXOs. **/
     totalBalance?: CurrencyAmount;
@@ -344,19 +367,21 @@ type BlockchainBalance = {
     availableBalance?: CurrencyAmount;
 };
 
-type LightsparkNodeToChannelsConnection = {
-    /** An object that holds pagination information about the objects in this connection. **/
-    pageInfo: PageInfo;
+type LightsparkNodeToChannelsConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The channels for the current page of this connection. **/
     entities: Channel[];
+    /** The typename of the object **/
+    typename: string;
 };
 
-/** An object that represents the address of a node on the Lightning Network. **/
+/** This object represents the address of a node on the Lightning Network. **/
 type NodeAddress = {
     /** The string representation of the address. **/
     address: string;
@@ -375,7 +400,7 @@ type NodeToAddressesConnection = {
     entities: NodeAddress[];
 };
 
-/** This interface represents a lightning node that can be connected to the Lightning Network to send and receive transactions. **/
+/** This object is an interface representing a Lightning Node on the Lightning Network, and could either be a Lightspark node or a node managed by a third party. **/
 declare class Node implements Entity {
     readonly id: string;
     readonly createdAt: string;
@@ -421,21 +446,23 @@ declare class LightsparkNode implements Node {
     readonly status?: LightsparkNodeStatus | undefined;
     constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, accountId: string, ownerId: string, typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, blockchainBalance?: BlockchainBalance | undefined, encryptedSigningPrivateKey?: Secret | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, purpose?: LightsparkNodePurpose | undefined, remoteBalance?: CurrencyAmount | undefined, status?: LightsparkNodeStatus | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
-    getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined): Promise<LightsparkNodeToChannelsConnection>;
+    getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeQuery(id: string): Query<LightsparkNode>;
 }
 
 /** A connection between an account and the nodes it manages. **/
-type AccountToNodesConnection = {
-    /** An object that holds pagination information about the objects in this connection. **/
-    pageInfo: PageInfo;
+type AccountToNodesConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The nodes for the current page of this connection. **/
     entities: LightsparkNode[];
+    /** The typename of the object **/
+    typename: string;
     /**
      * The main purpose for the selected set of nodes. It is automatically determined from the nodes that
      * are selected in this connection and is used for optimization purposes, as well as to determine the
@@ -444,7 +471,7 @@ type AccountToNodesConnection = {
     purpose?: LightsparkNodePurpose;
 };
 
-/** The interface of a payment request on the Lightning Network (a.k.a. Lightning Invoice). **/
+/** This object is an interface of a payment request on the Lightning Network (i.e., a Lightning Invoice). It contains data related to parsing the payment details of a Lightning Invoice. **/
 type PaymentRequestData = {
     encodedPaymentRequest: string;
     bitcoinNetwork: BitcoinNetwork;
@@ -452,6 +479,7 @@ type PaymentRequestData = {
     typename: string;
 };
 
+/** This is an enum of the potential states that a payment request on the Lightning Network can take. **/
 declare enum PaymentRequestStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -462,6 +490,7 @@ declare enum PaymentRequestStatus {
     CLOSED = "CLOSED"
 }
 
+/** This object contains information related to a payment request generated or received by a LightsparkNode. You can retrieve this object to receive payment information about a specific invoice. **/
 type PaymentRequest = Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -481,18 +510,21 @@ type PaymentRequest = Entity & {
 };
 declare const getPaymentRequestQuery: (id: string) => Query<PaymentRequest>;
 
-type AccountToPaymentRequestsConnection = {
-    /** The payment requests for the current page of this connection. **/
-    entities: PaymentRequest[];
-    /** An object that holds pagination information about the objects in this connection. **/
-    pageInfo: PageInfo;
+type AccountToPaymentRequestsConnection = Connection & {
     /**
      * 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;
+    count: number;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
+    /** The payment requests for the current page of this connection. **/
+    entities: PaymentRequest[];
+    /** The typename of the object **/
+    typename: string;
 };
 
+/** This is an enum of the potential statuses a transaction associated with your Lightspark Node can take. **/
 declare enum TransactionStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -513,6 +545,7 @@ declare enum TransactionStatus {
     CANCELLED = "CANCELLED"
 }
 
+/** This object represents a payment transaction. The transaction can occur either on a Bitcoin Network, or over the Lightning Network. You can retrieve this object to receive specific information about a particular transaction tied to your Lightspark Node. **/
 type Transaction = Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -536,16 +569,18 @@ type Transaction = Entity & {
 };
 declare const getTransactionQuery: (id: string) => Query<Transaction>;
 
-type AccountToTransactionsConnection = {
+type AccountToTransactionsConnection = Connection & {
     /**
      * 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 transactions for the current page of this connection. **/
-    entities: Transaction[];
     /** An object that holds pagination information about the objects in this connection. **/
     pageInfo: PageInfo;
+    /** The transactions for the current page of this connection. **/
+    entities: Transaction[];
+    /** The typename of the object **/
+    typename: string;
     /**
      * Profit (or loss) generated by the transactions in this connection, with the set of filters and
      * constraints provided.
@@ -563,6 +598,7 @@ type AccountToTransactionsConnection = {
     totalAmountTransacted?: CurrencyAmount;
 };
 
+/** This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations. **/
 type Balances = {
     /**
      * This represents the balance that should be displayed when asked "how much do I own right now?". It
@@ -586,6 +622,7 @@ type Balances = {
     availableToWithdrawBalance: CurrencyAmount;
 };
 
+/** This is an object representing the owner of a LightsparkNode. **/
 type LightsparkNodeOwner = Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -601,6 +638,7 @@ type LightsparkNodeOwner = Entity & {
 };
 declare const getLightsparkNodeOwnerQuery: (id: string) => Query<LightsparkNodeOwner>;
 
+/** This is an enum of the potential statuses that your Lightspark wallet can take.  **/
 declare enum WalletStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -627,6 +665,35 @@ declare enum WalletStatus {
     TERMINATED = "TERMINATED"
 }
 
+type WalletToPaymentRequestsConnection = Connection & {
+    /**
+     * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
+    /** The payment requests for the current page of this connection. **/
+    entities: PaymentRequest[];
+    /** The typename of the object **/
+    typename: string;
+};
+
+type WalletToTransactionsConnection = Connection & {
+    /**
+     * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
+    /** The transactions for the current page of this connection. **/
+    entities: Transaction[];
+    /** The typename of the object **/
+    typename: string;
+};
+
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -637,23 +704,28 @@ declare class Wallet implements LightsparkNodeOwner {
     readonly lastLoginAt?: string | undefined;
     readonly balances?: Balances | undefined;
     constructor(id: string, createdAt: string, updatedAt: string, thirdPartyIdentifier: string, status: WalletStatus, typename: string, lastLoginAt?: string | undefined, balances?: Balances | 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>;
     getTotalAmountSent(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
     static getWalletQuery(id: string): Query<Wallet>;
 }
 
-type AccountToWalletsConnection = {
-    /** An object that holds pagination information about the objects in this connection. **/
-    pageInfo: PageInfo;
+type AccountToWalletsConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The wallets for the current page of this connection. **/
     entities: Wallet[];
+    /** The typename of the object **/
+    typename: string;
 };
 
+/** This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed. **/
 declare enum PaymentFailureReason {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -672,6 +744,7 @@ declare enum PaymentFailureReason {
     RISK_SCREENING_FAILED = "RISK_SCREENING_FAILED"
 }
 
+/** This is an enum of the potential reasons that an attempted routed transaction through a Lightspark node may have failed. **/
 declare enum RoutingTransactionFailureReason {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -683,11 +756,13 @@ declare enum RoutingTransactionFailureReason {
     FORWARDING_FAILURE = "FORWARDING_FAILURE"
 }
 
+/** This object represents payment failures associated with your Lightspark Node. **/
 type TransactionFailures = {
     paymentFailures?: PaymentFailureReason[];
     routingTransactionFailures?: RoutingTransactionFailureReason[];
 };
 
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -695,17 +770,17 @@ declare class Account implements LightsparkNodeOwner {
     readonly typename: string;
     readonly name?: string | undefined;
     constructor(id: string, createdAt: string, updatedAt: string, typename: string, name?: string | undefined);
-    getApiTokens(client: LightsparkClient, first?: number | undefined): Promise<AccountToApiTokensConnection>;
+    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>;
     getLocalBalance(client: LightsparkClient, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<CurrencyAmount | null>;
-    getNodes(client: LightsparkClient, first?: number | undefined, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<AccountToNodesConnection>;
+    getNodes(client: LightsparkClient, first?: number | undefined, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined, after?: string | undefined): Promise<AccountToNodesConnection>;
     getRemoteBalance(client: LightsparkClient, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<CurrencyAmount | null>;
     getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<number>;
     getChannels(client: LightsparkClient, bitcoinNetwork: BitcoinNetwork, lightningNodeId?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, first?: number | undefined): Promise<AccountToChannelsConnection>;
     getTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined, types?: TransactionType[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined, statuses?: TransactionStatus[] | undefined, excludeFailures?: TransactionFailures | undefined): Promise<AccountToTransactionsConnection>;
     getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined): Promise<AccountToPaymentRequestsConnection>;
-    getWallets(client: LightsparkClient, first?: number | undefined): Promise<AccountToWalletsConnection>;
+    getWallets(client: LightsparkClient, first?: number | undefined, after?: string | undefined, thirdPartyIds?: string[] | undefined): Promise<AccountToWalletsConnection>;
     static getAccountQuery(): Query<Account>;
 }
 
@@ -720,12 +795,13 @@ type CreateApiTokenOutput = {
     clientSecret: string;
 };
 
+/** This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates are separated by potential confirmation speeds for settlement. **/
 type FeeEstimate = {
     feeFast: CurrencyAmount;
     feeMin: CurrencyAmount;
 };
 
-/** This object represents the BOLT #11 invoice protocol for Lightning Payments. See https://github.com/lightning/bolts/blob/master/11-payment-encoding.md. **/
+/** This object represents the data associated with a BOLT #11 invoice. You can retrieve this object to receive the relevant data associated with a specific invoice. **/
 type InvoiceData = PaymentRequestData & {
     encodedPaymentRequest: string;
     bitcoinNetwork: BitcoinNetwork;
@@ -748,7 +824,7 @@ type InvoiceData = PaymentRequestData & {
     memo?: string;
 };
 
-/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) initiated by a Lightspark Node. **/
+/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node. **/
 type Invoice = PaymentRequest & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -770,6 +846,7 @@ type Invoice = PaymentRequest & Entity & {
 };
 declare const getInvoiceQuery: (id: string) => Query<Invoice>;
 
+/** This is an enum for potential invoice types. **/
 declare enum InvoiceType {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -782,6 +859,7 @@ declare enum InvoiceType {
     AMP = "AMP"
 }
 
+/** This is an object representing a transaction made over the Lightning Network. You can retrieve this object to receive information about a specific transaction made over Lightning for a Lightspark node. **/
 type LightningTransaction = Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -805,6 +883,7 @@ type LightningTransaction = Transaction & Entity & {
 };
 declare const getLightningTransactionQuery: (id: string) => Query<LightningTransaction>;
 
+/** This is an enum representing a particular reason why an htlc sent over the Lightning Network may have failed. **/
 declare enum HtlcAttemptFailureCode {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -840,7 +919,7 @@ declare enum HtlcAttemptFailureCode {
     UNREADABLE_FAILURE = "UNREADABLE_FAILURE"
 }
 
-/** Enum that enumerates all the possible status of an outgoing payment attempt. **/
+/** This is an enum of all potential statuses of a payment attempt made from a Lightspark Node. **/
 declare enum OutgoingPaymentAttemptStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -852,7 +931,7 @@ declare enum OutgoingPaymentAttemptStatus {
     FAILED = "FAILED"
 }
 
-/** One hop signifies a payment moving one node ahead on a payment route; a list of sequential hops defines the path from sender node to recipient node for a payment attempt. **/
+/** This object represents a specific node that existed on a particular payment route. You can retrieve this object to get information about a node on a particular payment path and all payment-relevant information for that node. **/
 type Hop = Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -881,17 +960,21 @@ type Hop = Entity & {
 declare const getHopQuery: (id: string) => Query<Hop>;
 
 /** The connection from an outgoing payment attempt to the list of sequential hops that define the path from sender node to recipient node. **/
-type OutgoingPaymentAttemptToHopsConnection = {
+type OutgoingPaymentAttemptToHopsConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The hops for the current page of this connection. **/
     entities: Hop[];
+    /** The typename of the object **/
+    typename: string;
 };
 
-/** An attempt for a payment over a route from sender node to recipient node. **/
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -905,26 +988,30 @@ declare class OutgoingPaymentAttempt implements Entity {
     readonly amount?: CurrencyAmount | undefined;
     readonly fees?: CurrencyAmount | 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);
-    getHops(client: LightsparkClient, first?: number | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
+    getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
     static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
 }
 
 /** The connection from outgoing payment to all attempts. **/
-type OutgoingPaymentToAttemptsConnection = {
+type OutgoingPaymentToAttemptsConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The attempts for the current page of this connection. **/
     entities: OutgoingPaymentAttempt[];
+    /** The typename of the object **/
+    typename: string;
 };
 
 type RichText = {
     text: string;
 };
 
-/** A transaction that was sent from a Lightspark node on the Lightning Network. **/
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -941,7 +1028,7 @@ declare class OutgoingPayment implements LightningTransaction {
     readonly failureReason?: PaymentFailureReason | undefined;
     readonly failureMessage?: RichText | 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);
-    getAttempts(client: LightsparkClient, first?: number | undefined): Promise<OutgoingPaymentToAttemptsConnection>;
+    getAttempts(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentToAttemptsConnection>;
     static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
 }
 
@@ -991,6 +1078,7 @@ type TransactionUpdate = {
     transactionHash?: string;
 };
 
+/** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
 declare enum WithdrawalMode {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1001,6 +1089,7 @@ declare enum WithdrawalMode {
     WALLET_THEN_CHANNELS = "WALLET_THEN_CHANNELS"
 }
 
+/** This is an enum of the potential statuses that a Withdrawal can take. **/
 declare enum WithdrawalRequestStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1012,7 +1101,7 @@ declare enum WithdrawalRequestStatus {
     SUCCESSFUL = "SUCCESSFUL"
 }
 
-/** Transaction happened on Bitcoin blockchain. **/
+/** This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve this object to receive information about a specific on-chain transaction made on the Lightning Network associated with your Lightspark Node. **/
 type OnChainTransaction = Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1055,7 +1144,7 @@ type OnChainTransaction = Transaction & Entity & {
 };
 declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
 
-/** The transaction on Bitcoin blockchain to close a channel on Lightning Network where the balances are allocated back to local and remote nodes. **/
+/** This is an object representing a transaction which closes a channel on the Lightning Network. This operation allocates balances back to the local and remote nodes. **/
 type ChannelClosingTransaction = OnChainTransaction & Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1112,7 +1201,7 @@ type WithdrawalRequestToChannelClosingTransactionsConnection = {
     entities: ChannelClosingTransaction[];
 };
 
-/** The transaction on Bitcoin blockchain to open a channel on Lightning Network funded by the local Lightspark node. **/
+/** This is an object representing a transaction which opens a channel on the Lightning Network. This object occurs only for channels funded by the local Lightspark node. **/
 type ChannelOpeningTransaction = OnChainTransaction & Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1169,6 +1258,7 @@ type WithdrawalRequestToChannelOpeningTransactionsConnection = {
     entities: ChannelOpeningTransaction[];
 };
 
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -1475,10 +1565,16 @@ type CreateApiTokenInput = {
 };
 
 type CreateInvoiceInput = {
+    /** The node from which to create the invoice. **/
     nodeId: string;
+    /** The amount for which the invoice should be created, in millisatoshis. **/
     amountMsats: number;
     memo?: string;
     invoiceType?: InvoiceType;
+    /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
+    expirySecs?: number;
+    paymentHash?: string;
+    preimageNonce?: string;
 };
 
 type CreateInvoiceOutput = {
@@ -1495,6 +1591,10 @@ type CreateLnurlInvoiceInput = {
      * payment) of the resulting Bolt 11 invoice.
      **/
     metadataHash: string;
+    /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
+    expirySecs?: number;
+    paymentHash?: string;
+    preimageNonce?: string;
 };
 
 type CreateNodeWalletAddressInput = {
@@ -1529,11 +1629,22 @@ type CreateTestModePaymentInput = {
     amountMsats?: number;
 };
 
+/** This is an object identifying the output of a test mode payment. This object can be used to retrieve the associated payment made from a Test Mode Payment call. **/
 type CreateTestModePaymentoutput = {
     /** The payment that has been sent. **/
     paymentId: string;
 };
 
+/** This is an enum identifying a type of crypto sanctions screening provider. **/
+declare enum CryptoSanctionsScreeningProvider {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    CHAINALYSIS = "CHAINALYSIS"
+}
+
 type DeleteApiTokenInput = {
     apiTokenId: string;
 };
@@ -1542,7 +1653,7 @@ type DeleteApiTokenOutput = {
     accountId: string;
 };
 
-/** The transaction on Bitcoin blockchain to fund the Lightspark node's wallet. **/
+/** This object represents a Deposit made to a Lightspark node wallet. This operation occurs for any L1 funding transaction to the wallet. You can retrieve this object to receive detailed information about the deposit. **/
 type Deposit = OnChainTransaction & Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1596,7 +1707,7 @@ type FundNodeOutput = {
     amount: CurrencyAmount;
 };
 
-/** This is a node on the Lightning Network, managed by a third party. The information about this node is public data that has been obtained by observing the Lightning Network. **/
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -1613,7 +1724,7 @@ declare class GraphNode implements Node {
     static getGraphNodeQuery(id: string): Query<GraphNode>;
 }
 
-/** Enum that enumerates all the possible status of an incoming payment attempt. **/
+/** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
 declare enum IncomingPaymentAttemptStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1626,7 +1737,7 @@ declare enum IncomingPaymentAttemptStatus {
     UNKNOWN = "UNKNOWN"
 }
 
-/** An attempt for a payment over a route from sender node to recipient node. **/
+/** This object represents any attempted payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific incoming payment attempt. **/
 type IncomingPaymentAttempt = Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1651,17 +1762,21 @@ type IncomingPaymentAttempt = Entity & {
 declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaymentAttempt>;
 
 /** The connection from incoming payment to all attempts. **/
-type IncomingPaymentToAttemptsConnection = {
+type IncomingPaymentToAttemptsConnection = Connection & {
     /**
      * 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;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
     /** The incoming payment attempts for the current page of this connection. **/
     entities: IncomingPaymentAttempt[];
+    /** The typename of the object **/
+    typename: string;
 };
 
-/** A transaction that was sent to a Lightspark node on the Lightning Network. **/
+/** 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 {
     readonly id: string;
     readonly createdAt: string;
@@ -1675,7 +1790,7 @@ declare class IncomingPayment implements LightningTransaction {
     readonly originId?: string | undefined;
     readonly paymentRequestId?: string | undefined;
     constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, destinationId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, originId?: string | undefined, paymentRequestId?: string | undefined);
-    getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined): Promise<IncomingPaymentToAttemptsConnection>;
+    getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
     static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
 }
 
@@ -1745,7 +1860,19 @@ type RequestWithdrawalOutput = {
     requestId: string;
 };
 
-/** A transaction that was forwarded through a Lightspark node on the Lightning Network. **/
+/** This is an enum of the potential risk ratings related to a transaction made over the Lightning Network. These risk ratings are returned from the CryptoSanctionScreeningProvider. **/
+declare enum RiskRating {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    HIGH_RISK = "HIGH_RISK",
+    LOW_RISK = "LOW_RISK",
+    UNKNOWN = "UNKNOWN"
+}
+
+/** This object represents a transaction that was forwarded through a Lightspark node on the Lightning Network, i.e., a routed transaction. You can retrieve this object to receive information about any transaction routed through your Lightspark Node. **/
 type RoutingTransaction = LightningTransaction & Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1782,6 +1909,15 @@ type RoutingTransaction = LightningTransaction & Transaction & Entity & {
 };
 declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransaction>;
 
+type ScreenBitcoinAddressesInput = {
+    provider: CryptoSanctionsScreeningProvider;
+    addresses: string[];
+};
+
+type ScreenBitcoinAddressesOutput = {
+    ratings: RiskRating[];
+};
+
 type SendPaymentInput = {
     /** The node from where you want to send the payment. **/
     nodeId: string;
@@ -1800,6 +1936,7 @@ type SendPaymentOutput = {
     paymentId: string;
 };
 
+/** This is an enum of the potential event types that can be associated with your Lightspark wallets. **/
 declare enum WebhookEventType {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1812,10 +1949,11 @@ declare enum WebhookEventType {
     WALLET_OUTGOING_PAYMENT_FINISHED = "WALLET_OUTGOING_PAYMENT_FINISHED",
     WALLET_INCOMING_PAYMENT_FINISHED = "WALLET_INCOMING_PAYMENT_FINISHED",
     WALLET_WITHDRAWAL_FINISHED = "WALLET_WITHDRAWAL_FINISHED",
-    WALLET_FUNDS_RECEIVED = "WALLET_FUNDS_RECEIVED"
+    WALLET_FUNDS_RECEIVED = "WALLET_FUNDS_RECEIVED",
+    REMOTE_SIGNING = "REMOTE_SIGNING"
 }
 
-/** The transaction on the Bitcoin blockchain to withdraw funds from the Lightspark node to a Bitcoin wallet. **/
+/** This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any L1 withdrawal associated with your Lightspark Node or account. **/
 type Withdrawal = OnChainTransaction & Transaction & Entity & {
     /**
      * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -1860,4 +1998,4 @@ type Withdrawal = OnChainTransaction & Transaction & Entity & {
 };
 declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
 
-export { getInvoiceQuery as $, Account as A, Balances as B, Channel as C, CreateTestModePaymentInput as D, CreateTestModePaymentoutput as E, CurrencyAmount as F, CurrencyUnit as G, DeleteApiTokenInput as H, DeleteApiTokenOutput as I, Deposit as J, getDepositQuery as K, LightsparkClient as L, Entity as M, FeeEstimate as N, FundNodeInput as O, FundNodeOutput as P, GraphNode as Q, Hop as R, getHopQuery as S, HtlcAttemptFailureCode as T, IncomingPayment as U, IncomingPaymentAttempt as V, WebhookEventType as W, getIncomingPaymentAttemptQuery as X, IncomingPaymentAttemptStatus as Y, IncomingPaymentToAttemptsConnection as Z, Invoice as _, AccountToApiTokensConnection as a, InvoiceData as a0, InvoiceType as a1, LightningFeeEstimateForInvoiceInput as a2, LightningFeeEstimateForNodeInput as a3, LightningFeeEstimateOutput as a4, LightningTransaction as a5, getLightningTransactionQuery as a6, LightsparkNode as a7, LightsparkNodeOwner as a8, getLightsparkNodeOwnerQuery as a9, RoutingTransaction as aA, getRoutingTransactionQuery as aB, RoutingTransactionFailureReason as aC, Secret as aD, SendPaymentInput as aE, SendPaymentOutput as aF, SingleNodeDashboard as aG, Transaction as aH, getTransactionQuery as aI, TransactionFailures as aJ, TransactionStatus as aK, TransactionType as aL, TransactionUpdate as aM, Wallet as aN, WalletStatus as aO, Withdrawal as aP, getWithdrawalQuery as aQ, WithdrawalMode as aR, WithdrawalRequest as aS, WithdrawalRequestStatus as aT, WithdrawalRequestToChannelClosingTransactionsConnection as aU, WithdrawalRequestToChannelOpeningTransactionsConnection as aV, LightsparkNodePurpose as aa, LightsparkNodeStatus as ab, LightsparkNodeToChannelsConnection as ac, Node as ad, NodeAddress as ae, NodeAddressType as af, NodeToAddressesConnection as ag, OnChainTransaction as ah, getOnChainTransactionQuery as ai, OutgoingPayment as aj, OutgoingPaymentAttempt as ak, OutgoingPaymentAttemptStatus as al, OutgoingPaymentAttemptToHopsConnection as am, OutgoingPaymentToAttemptsConnection as an, PageInfo as ao, PayInvoiceInput as ap, PayInvoiceOutput as aq, PaymentFailureReason as ar, PaymentRequest as as, getPaymentRequestQuery as at, PaymentRequestData as au, PaymentRequestStatus as av, Permission as aw, RequestWithdrawalInput as ax, RequestWithdrawalOutput as ay, RichText as az, AccountToChannelsConnection as b, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BitcoinNetwork as i, BlockchainBalance as j, ChannelClosingTransaction as k, getChannelClosingTransactionQuery as l, ChannelFees as m, ChannelOpeningTransaction as n, getChannelOpeningTransactionQuery as o, ChannelStatus as p, ChannelToTransactionsConnection as q, CreateApiTokenInput as r, CreateApiTokenOutput as s, CreateInvoiceInput as t, CreateInvoiceOutput as u, CreateLnurlInvoiceInput as v, CreateNodeWalletAddressInput as w, CreateNodeWalletAddressOutput as x, CreateTestModeInvoiceInput as y, CreateTestModeInvoiceOutput as z };
+export { IncomingPaymentToAttemptsConnection as $, Account as A, Balances as B, Channel as C, CreateTestModeInvoiceOutput as D, CreateTestModePaymentInput as E, CreateTestModePaymentoutput as F, CryptoSanctionsScreeningProvider as G, CurrencyAmount as H, CurrencyUnit as I, DeleteApiTokenInput as J, DeleteApiTokenOutput as K, LightsparkClient as L, Deposit as M, getDepositQuery as N, Entity as O, FeeEstimate as P, FundNodeInput as Q, FundNodeOutput as R, GraphNode as S, Hop as T, getHopQuery as U, HtlcAttemptFailureCode as V, WebhookEventType as W, IncomingPayment as X, IncomingPaymentAttempt as Y, getIncomingPaymentAttemptQuery as Z, IncomingPaymentAttemptStatus as _, AccountToApiTokensConnection as a, WithdrawalRequestToChannelClosingTransactionsConnection as a$, Invoice as a0, getInvoiceQuery as a1, InvoiceData as a2, InvoiceType as a3, LightningFeeEstimateForInvoiceInput as a4, LightningFeeEstimateForNodeInput as a5, LightningFeeEstimateOutput as a6, LightningTransaction as a7, getLightningTransactionQuery as a8, LightsparkNode as a9, RequestWithdrawalOutput as aA, RichText as aB, RiskRating as aC, RoutingTransaction as aD, getRoutingTransactionQuery as aE, RoutingTransactionFailureReason as aF, ScreenBitcoinAddressesInput as aG, ScreenBitcoinAddressesOutput as aH, Secret as aI, SendPaymentInput as aJ, SendPaymentOutput as aK, SingleNodeDashboard as aL, Transaction as aM, getTransactionQuery as aN, TransactionFailures as aO, TransactionStatus as aP, TransactionType as aQ, TransactionUpdate as aR, Wallet as aS, WalletStatus as aT, WalletToPaymentRequestsConnection as aU, WalletToTransactionsConnection as aV, Withdrawal as aW, getWithdrawalQuery as aX, WithdrawalMode as aY, WithdrawalRequest as aZ, WithdrawalRequestStatus as a_, LightsparkNodeOwner as aa, getLightsparkNodeOwnerQuery as ab, LightsparkNodePurpose as ac, LightsparkNodeStatus as ad, LightsparkNodeToChannelsConnection as ae, Node as af, NodeAddress as ag, NodeAddressType as ah, NodeToAddressesConnection as ai, OnChainTransaction as aj, getOnChainTransactionQuery as ak, OutgoingPayment as al, OutgoingPaymentAttempt as am, OutgoingPaymentAttemptStatus as an, OutgoingPaymentAttemptToHopsConnection as ao, OutgoingPaymentToAttemptsConnection as ap, PageInfo as aq, PayInvoiceInput as ar, PayInvoiceOutput as as, PaymentFailureReason as at, PaymentRequest as au, getPaymentRequestQuery as av, PaymentRequestData as aw, PaymentRequestStatus as ax, Permission as ay, RequestWithdrawalInput as az, AccountToChannelsConnection as b, WithdrawalRequestToChannelOpeningTransactionsConnection as b0, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BitcoinNetwork as i, BlockchainBalance as j, ChannelClosingTransaction as k, getChannelClosingTransactionQuery as l, ChannelFees as m, ChannelOpeningTransaction as n, getChannelOpeningTransactionQuery as o, ChannelStatus as p, ChannelToTransactionsConnection as q, Connection as r, CreateApiTokenInput as s, CreateApiTokenOutput as t, CreateInvoiceInput as u, CreateInvoiceOutput as v, CreateLnurlInvoiceInput as w, CreateNodeWalletAddressInput as x, CreateNodeWalletAddressOutput as y, CreateTestModeInvoiceInput as z };