@lightsparkdev/lightspark-sdk 1.2.2 → 1.3.0

package/src/objects/Account.ts

@@ -26,12 +26,16 @@ import type TransactionFailures from "./TransactionFailures.js";
 import type TransactionStatus from "./TransactionStatus.js";
 import type TransactionType from "./TransactionType.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 class Account implements LightsparkNodeOwner, Entity {
   constructor(
     /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
+     * The unique identifier of this entity across all Lightspark systems.
+     * Should be treated as an opaque string.
      **/
     public readonly id: string,
     /** The date and time when the entity was first created. **/

package/src/objects/AccountToApiTokensConnection.ts

@@ -7,8 +7,9 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
 interface AccountToApiTokensConnection {
   /**
-   * 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).
+   * 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;
 

package/src/objects/AccountToChannelsConnection.ts

@@ -7,8 +7,9 @@ import { ChannelFromJson } from "./Channel.js";
 class AccountToChannelsConnection {
   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).
+     * 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).
      **/
     public readonly count: number,
     /** The channels for the current page of this connection. **/

package/src/objects/AccountToNodesConnection.ts

@@ -11,8 +11,9 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 /** A connection between an account and the nodes it manages. **/
 interface AccountToNodesConnection {
   /**
-   * 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).
+   * 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;
 

package/src/objects/AccountToPaymentRequestsConnection.ts

@@ -10,8 +10,9 @@ import {
 
 interface AccountToPaymentRequestsConnection {
   /**
-   * 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).
+   * 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;
 

package/src/objects/AccountToTransactionsConnection.ts

@@ -12,8 +12,9 @@ import { TransactionFromJson, TransactionToJson } from "./Transaction.js";
 
 interface AccountToTransactionsConnection {
   /**
-   * 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).
+   * 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;
 
@@ -27,14 +28,14 @@ interface AccountToTransactionsConnection {
   typename: string;
 
   /**
-   * Profit (or loss) generated by the transactions in this connection, with the set of filters and
-   * constraints provided.
+   * Profit (or loss) generated by the transactions in this connection,
+   * with the set of filters and constraints provided.
    **/
   profitLoss?: CurrencyAmount | undefined;
 
   /**
-   * Average fee earned for the transactions in this connection, with the set of filters and constraints
-   * provided.
+   * Average fee earned for the transactions in this connection,
+   * with the set of filters and constraints provided.
    **/
   averageFeeEarned?: CurrencyAmount | undefined;
 

package/src/objects/AccountToWalletsConnection.ts

@@ -7,8 +7,9 @@ import { WalletFromJson } from "./Wallet.js";
 
 interface AccountToWalletsConnection {
   /**
-   * 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).
+   * 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;
 

package/src/objects/ApiToken.ts

@@ -3,11 +3,16 @@
 import { type Query } from "@lightsparkdev/core";
 import Permission from "./Permission.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface ApiToken {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 
@@ -24,8 +29,8 @@ interface ApiToken {
   clientId: string;
 
   /**
-   * An arbitrary name chosen by the creator of the token to help identify the token in the list of
-   * tokens that have been created for the account.
+   * An arbitrary name chosen by the creator of the token to help identify the token in the list
+   * of tokens that have been created for the account.
    **/
   name: string;
 

package/src/objects/Balances.ts

@@ -6,28 +6,36 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface Balances {
   /**
-   * This represents the balance that should be displayed when asked "how much do I own right now?". It
-   * represents the amount currently owned, including things that may not be owned soon (e.g. in-flight
-   * outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a snapshot of what is
-   * officially owned at this instant.
+   * This represents the balance that should be displayed when asked "how much do I own right
+   * now?". It represents the amount currently owned,
+   * including things that may not be owned soon (e.g. in-flight outgoing payments, in-flight
+   * withdrawals, commit fees, etc.). It really is a snapshot of what is officially owned at this
+   * instant.
    **/
   ownedBalance: CurrencyAmount;
 
   /**
-   * This represents the balance that should be displayed when asked "how much can I send on Lightning
-   * right now?". It represents the amount currently available to be sent on the Lightning network. We
-   * remove from the balance all the funds that are temporarily locked (e.g. channel reserves).
+   * This represents the balance that should be displayed when asked "how much can I send on
+   * Lightning right now?". It represents the amount currently available to be sent on the
+   * Lightning network. We remove from the balance all the funds that are temporarily locked
+   * (e.g. channel reserves).
    **/
   availableToSendBalance: CurrencyAmount;
 
   /**
-   * This represents the balance that should be displayed when asked "how much money can I withdraw on
-   * the Bitcoin network right now?". It represents the amount currently available to withdraw and is
-   * usually equal to the `owned_balance` but it does not include in-flight operations (which would
-   * likely succeed and therefore likely make your withdrawal fail).
+   * This represents the balance that should be displayed when asked "how much money can I
+   * withdraw on the Bitcoin network right now?".
+   * It represents the amount currently available to withdraw and is usually equal to the
+   * `owned_balance` but it does not include in-flight operations (which would likely succeed and
+   * therefore likely make your withdrawal fail).
    **/
   availableToWithdrawBalance: CurrencyAmount;
 }

package/src/objects/BitcoinNetwork.ts

@@ -11,7 +11,10 @@ export enum BitcoinNetwork {
   MAINNET = "MAINNET",
   /** A test version of the Bitcoin Blockchain, maintained by Lightspark. **/
   REGTEST = "REGTEST",
-  /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
+  /**
+   * 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, publicly available. **/
   TESTNET = "TESTNET",

package/src/objects/CancelInvoiceInput.ts

@@ -0,0 +1,18 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CancelInvoiceInput {
+  invoiceId: string;
+}
+
+export const CancelInvoiceInputFromJson = (obj: any): CancelInvoiceInput => {
+  return {
+    invoiceId: obj["cancel_invoice_input_invoice_id"],
+  } as CancelInvoiceInput;
+};
+export const CancelInvoiceInputToJson = (obj: CancelInvoiceInput): any => {
+  return {
+    cancel_invoice_input_invoice_id: obj.invoiceId,
+  };
+};
+
+export default CancelInvoiceInput;

package/src/objects/CancelInvoiceOutput.ts

@@ -0,0 +1,26 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CancelInvoiceOutput {
+  invoiceId: string;
+}
+
+export const CancelInvoiceOutputFromJson = (obj: any): CancelInvoiceOutput => {
+  return {
+    invoiceId: obj["cancel_invoice_output_invoice"].id,
+  } as CancelInvoiceOutput;
+};
+export const CancelInvoiceOutputToJson = (obj: CancelInvoiceOutput): any => {
+  return {
+    cancel_invoice_output_invoice: { id: obj.invoiceId },
+  };
+};
+
+export const FRAGMENT = `
+fragment CancelInvoiceOutputFragment on CancelInvoiceOutput {
+    __typename
+    cancel_invoice_output_invoice: invoice {
+        id
+    }
+}`;
+
+export default CancelInvoiceOutput;

package/src/objects/Channel.ts

@@ -16,12 +16,16 @@ import {
 import type Entity from "./Entity.js";
 import type TransactionType from "./TransactionType.js";
 
-/** 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. **/
+/**
+ * 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. *
+ */
 class Channel implements Entity {
   constructor(
     /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
+     * The unique identifier of this entity across all Lightspark systems.
+     * Should be treated as an opaque string.
      **/
     public readonly id: string,
     /** The date and time when the entity was first created. **/
@@ -35,27 +39,36 @@ class Channel implements Entity {
     /** The transaction that funded the channel upon channel opening. **/
     public 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.
+     * 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.
      **/
     public readonly capacity?: CurrencyAmount | undefined,
     /** The channel balance on the local node. **/
     public readonly localBalance?: CurrencyAmount | undefined,
-    /** The channel balance on the local node that is currently allocated to in-progress payments. **/
+    /**
+     * The channel balance on the local node that is currently allocated to in-progress payments.
+     * *
+     */
     public readonly localUnsettledBalance?: CurrencyAmount | undefined,
     /** The channel balance on the remote node. **/
     public readonly remoteBalance?: CurrencyAmount | undefined,
-    /** The channel balance on the remote node that is currently allocated to in-progress payments. **/
+    /**
+     * The channel balance on the remote node that is currently allocated to in-progress payments.
+     * *
+     */
     public readonly remoteUnsettledBalance?: CurrencyAmount | undefined,
     /** The channel balance that is currently allocated to in-progress payments. **/
     public readonly unsettledBalance?: CurrencyAmount | undefined,
-    /** The total balance in this channel, including the channel balance on both local and remote nodes. **/
+    /**
+     * The total balance in this channel, including the channel balance on both local and remote
+     * nodes. *
+     */
     public readonly totalBalance?: CurrencyAmount | undefined,
     /** The current status of this channel. **/
     public 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.
+     * 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.
      **/
     public readonly estimatedForceClosureWaitMinutes?: number | undefined,
     /** The amount to be paid in fees for the current set of commitment transactions. **/
@@ -65,8 +78,9 @@ class Channel implements Entity {
     /** If known, the remote node of the channel. **/
     public 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>.
+     * 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>.
      **/
     public readonly shortChannelId?: string | undefined,
   ) {

package/src/objects/ChannelClosingTransaction.ts

@@ -8,11 +8,15 @@ import {
 } from "./CurrencyAmount.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface ChannelClosingTransaction {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/ChannelOpeningTransaction.ts

@@ -8,11 +8,15 @@ import {
 } from "./CurrencyAmount.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface ChannelOpeningTransaction {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/ChannelStatus.ts

@@ -9,17 +9,36 @@ export enum ChannelStatus {
   FUTURE_VALUE = "FUTURE_VALUE",
   /** The channel is online and ready to send and receive funds. **/
   OK = "OK",
-  /** The channel has been created, but the Bitcoin transaction that initiates it still needs to be confirmed on the Bitcoin blockchain. **/
+  /**
+   * The channel has been created, but the Bitcoin transaction that initiates it still needs to be
+   * confirmed on the Bitcoin blockchain. *
+   */
   PENDING = "PENDING",
   /** The channel is not available, likely because the peer is not online. **/
   OFFLINE = "OFFLINE",
-  /** The channel is behaving properly, but its remote balance is much higher than its local balance so it is not balanced properly for sending funds out. **/
+  /**
+   * The channel is behaving properly, but its remote balance is much higher than its local balance
+   * so it is not balanced properly for sending funds out.
+   * *
+   */
   UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
-  /** The channel is behaving properly, but its remote balance is much lower than its local balance so it is not balanced properly for receiving funds. **/
+  /**
+   * The channel is behaving properly, but its remote balance is much lower than its local balance
+   * so it is not balanced properly for receiving funds.
+   * *
+   */
   UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
-  /** The channel has been closed. Information about the channel is still available for historical purposes but the channel cannot be used anymore. **/
+  /**
+   * The channel has been closed. Information about the channel is still available for historical
+   * purposes but the channel cannot be used anymore.
+   * *
+   */
   CLOSED = "CLOSED",
-  /** Something unexpected happened and we cannot determine the status of this channel. Please try again later or contact the support. **/
+  /**
+   * Something unexpected happened and we cannot determine the status of this channel.
+   * Please try again later or contact the support.
+   * *
+   */
   ERROR = "ERROR",
 }
 

package/src/objects/ChannelToTransactionsConnection.ts

@@ -8,26 +8,27 @@ import {
 
 interface ChannelToTransactionsConnection {
   /**
-   * 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).
+   * 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 average fee for the transactions that transited through this channel, according to the filters
-   * and constraints of the connection.
+   * The average fee for the transactions that transited through this channel,
+   * according to the filters and constraints of the connection.
    **/
   averageFee?: CurrencyAmount | undefined;
 
   /**
-   * The total amount transacted for the transactions that transited through this channel, according to
-   * the filters and constraints of the connection.
+   * The total amount transacted for the transactions that transited through this channel,
+   * according to the filters and constraints of the connection.
    **/
   totalAmountTransacted?: CurrencyAmount | undefined;
 
   /**
-   * The total amount of fees for the transactions that transited through this channel, according to the
-   * filters and constraints of the connection.
+   * The total amount of fees for the transactions that transited through this channel,
+   * according to the filters and constraints of the connection.
    **/
   totalFees?: CurrencyAmount | undefined;
 }

package/src/objects/Connection.ts

@@ -39,8 +39,9 @@ import type WalletToTransactionsConnection from "./WalletToTransactionsConnectio
 
 interface 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).
+   * 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;
 

package/src/objects/CreateApiTokenOutput.ts

@@ -8,9 +8,9 @@ interface CreateApiTokenOutput {
   apiToken: ApiToken;
 
   /**
-   * The secret that should be used to authenticate against our API. This secret is not stored and will
-   * never be available again after this. You must keep this secret secure as it grants access to your
-   * account.
+   * The secret that should be used to authenticate against our API.
+   * This secret is not stored and will never be available again after this.
+   * You must keep this secret secure as it grants access to your account.
    **/
   clientSecret: string;
 }

package/src/objects/CreateLnurlInvoiceInput.ts

@@ -8,8 +8,9 @@ interface CreateLnurlInvoiceInput {
   amountMsats: number;
 
   /**
-   * The SHA256 hash of the LNURL metadata payload. This will be present in the h-tag (SHA256 purpose of
-   * payment) of the resulting Bolt 11 invoice.
+   * The SHA256 hash of the LNURL metadata payload.
+   * This will be present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11
+   * invoice.
    **/
   metadataHash: string;
 

package/src/objects/CreateTestModePaymentInput.ts

@@ -8,8 +8,8 @@ interface CreateTestModePaymentInput {
   encodedInvoice: string;
 
   /**
-   * The amount you will be paid for this invoice, expressed in msats. It should ONLY be set when the
-   * invoice amount is zero.
+   * The amount you will be paid for this invoice, expressed in msats.
+   * It should ONLY be set when the invoice amount is zero.
    **/
   amountMsats?: number | undefined;
 }

package/src/objects/CreateTestModePaymentoutput.ts

@@ -1,6 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface CreateTestModePaymentoutput {
   /**
    * The payment that has been sent.

package/src/objects/CurrencyAmount.ts

@@ -20,8 +20,8 @@ interface CurrencyAmount {
   preferredCurrencyValueRounded: number;
 
   /**
-   * The approximate float value for this CurrencyAmount in the very base level of user's preferred
-   * currency. For example, for USD, the value will be in cents.
+   * The approximate float value for this CurrencyAmount in the very base level of user's
+   * preferred currency. For example, for USD, the value will be in cents.
    **/
   preferredCurrencyValueApprox: number;
 }

package/src/objects/CurrencyUnit.ts

@@ -7,19 +7,42 @@ export enum CurrencyUnit {
    * Clients should support unknown values as more of them could be added without notice.
    */
   FUTURE_VALUE = "FUTURE_VALUE",
-  /** Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium for value transfer for the Lightning Network. **/
+  /**
+   * Bitcoin is the cryptocurrency native to the Bitcoin network.
+   * It is used as the native medium for value transfer for the Lightning Network.
+   * *
+   */
   BITCOIN = "BITCOIN",
-  /** 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most commonly used in Lightning transactions. **/
+  /**
+   * 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin.
+   * This is the unit most commonly used in Lightning transactions.
+   * *
+   */
   SATOSHI = "SATOSHI",
-  /** 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  /**
+   * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
+   * *
+   */
   MILLISATOSHI = "MILLISATOSHI",
   /** United States Dollar. **/
   USD = "USD",
-  /** 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  /**
+   * 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin.
+   * We recommend using the Satoshi unit instead when possible.
+   * *
+   */
   NANOBITCOIN = "NANOBITCOIN",
-  /** 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  /**
+   * 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin.
+   * We recommend using the Satoshi unit instead when possible.
+   * *
+   */
   MICROBITCOIN = "MICROBITCOIN",
-  /** 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  /**
+   * 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin.
+   * We recommend using the Satoshi unit instead when possible.
+   * *
+   */
   MILLIBITCOIN = "MILLIBITCOIN",
 }
 

package/src/objects/Deposit.ts

@@ -8,11 +8,16 @@ import {
 } from "./CurrencyAmount.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface Deposit {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/Entity.ts

@@ -1,10 +1,15 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface Entity {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/FeeEstimate.ts

@@ -6,7 +6,11 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/** This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates are separated by potential confirmation speeds for settlement. **/
+/**
+ * This object represents the estimated L1 transaction fees for the Bitcoin network.
+ * Fee estimates are separated by potential confirmation speeds for settlement.
+ * *
+ */
 interface FeeEstimate {
   feeFast: CurrencyAmount;