@lightsparkdev/lightspark-sdk 0.4.9 → 0.4.11

package/src/objects/LightsparkNodeOwner.ts

@@ -1,13 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
-import { LightsparkException } from "@lightsparkdev/core";
+import { LightsparkException, type Query } from "@lightsparkdev/core";
 import Account from "./Account.js";
 import { BalancesFromJson } from "./Balances.js";
 import type Entity from "./Entity.js";
 import Wallet from "./Wallet.js";
 import WalletStatus from "./WalletStatus.js";
 
+/** 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
@@ -32,7 +32,7 @@ export const LightsparkNodeOwnerFromJson = (obj: any): LightsparkNodeOwner => {
       obj["account_created_at"],
       obj["account_updated_at"],
       "Account",
-      obj["account_name"]
+      obj["account_name"],
     );
   }
   if (obj["__typename"] == "Wallet") {
@@ -46,12 +46,12 @@ export const LightsparkNodeOwnerFromJson = (obj: any): LightsparkNodeOwner => {
       obj["wallet_last_login_at"],
       !!obj["wallet_balances"]
         ? BalancesFromJson(obj["wallet_balances"])
-        : undefined
+        : undefined,
     );
   }
   throw new LightsparkException(
     "DeserializationError",
-    `Couldn't find a concrete type for interface LightsparkNodeOwner corresponding to the typename=${obj["__typename"]}`
+    `Couldn't find a concrete type for interface LightsparkNodeOwner corresponding to the typename=${obj["__typename"]}`,
   );
 };
 
@@ -104,7 +104,7 @@ fragment LightsparkNodeOwnerFragment on LightsparkNodeOwner {
 }`;
 
 export const getLightsparkNodeOwnerQuery = (
-  id: string
+  id: string,
 ): Query<LightsparkNodeOwner> => {
   return {
     queryPayload: `

package/src/objects/LightsparkNodePurpose.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of potential purposes set by a user for a Lightspark node. **/
 export enum LightsparkNodePurpose {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/LightsparkNodeToChannelsConnection.ts

@@ -2,40 +2,46 @@
 
 import type Channel from "./Channel.js";
 import { ChannelFromJson } from "./Channel.js";
+import type Connection from "./Connection.js";
 import type PageInfo from "./PageInfo.js";
 import { PageInfoFromJson } from "./PageInfo.js";
 
-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;
 };
 
 export const LightsparkNodeToChannelsConnectionFromJson = (
-  obj: any
+  obj: any,
 ): LightsparkNodeToChannelsConnection => {
   return {
+    count: obj["lightspark_node_to_channels_connection_count"],
     pageInfo: PageInfoFromJson(
-      obj["lightspark_node_to_channels_connection_page_info"]
+      obj["lightspark_node_to_channels_connection_page_info"],
     ),
-    count: obj["lightspark_node_to_channels_connection_count"],
     entities: obj["lightspark_node_to_channels_connection_entities"].map((e) =>
-      ChannelFromJson(e)
+      ChannelFromJson(e),
     ),
+    typename: "LightsparkNodeToChannelsConnection",
   } as LightsparkNodeToChannelsConnection;
 };
 
 export const FRAGMENT = `
 fragment LightsparkNodeToChannelsConnectionFragment on LightsparkNodeToChannelsConnection {
     __typename
+    lightspark_node_to_channels_connection_count: count
     lightspark_node_to_channels_connection_page_info: page_info {
         __typename
         page_info_has_next_page: has_next_page
@@ -43,7 +49,6 @@ fragment LightsparkNodeToChannelsConnectionFragment on LightsparkNodeToChannelsC
         page_info_start_cursor: start_cursor
         page_info_end_cursor: end_cursor
     }
-    lightspark_node_to_channels_connection_count: count
     lightspark_node_to_channels_connection_entities: entities {
         id
     }

package/src/objects/Node.ts

@@ -1,7 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
-import { LightsparkException } from "@lightsparkdev/core";
+import { LightsparkException, type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import BitcoinNetwork from "./BitcoinNetwork.js";
@@ -17,7 +16,7 @@ import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
 import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.js";
 import { SecretFromJson } from "./Secret.js";
 
-/** 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. **/
 class Node implements Entity {
   constructor(
     public readonly id: string,
@@ -29,7 +28,7 @@ class Node implements Entity {
     public readonly alias?: string,
     public readonly color?: string,
     public readonly conductivity?: number,
-    public readonly publicKey?: string
+    public readonly publicKey?: string,
   ) {
     autoBind(this);
   }
@@ -37,7 +36,7 @@ class Node implements Entity {
   public async getAddresses(
     client: LightsparkClient,
     first: number | undefined = undefined,
-    types: NodeAddressType[] | undefined = undefined
+    types: NodeAddressType[] | undefined = undefined,
   ): Promise<NodeToAddressesConnection> {
     return (await client.executeRawQuery({
       queryPayload: ` 
@@ -97,7 +96,7 @@ export const NodeFromJson = (obj: any): Node => {
       obj["graph_node_alias"],
       obj["graph_node_color"],
       obj["graph_node_conductivity"],
-      obj["graph_node_public_key"]
+      obj["graph_node_public_key"],
     );
   }
   if (obj["__typename"] == "LightsparkNode") {
@@ -140,12 +139,12 @@ export const NodeFromJson = (obj: any): Node => {
       !!obj["lightspark_node_status"]
         ? LightsparkNodeStatus[obj["lightspark_node_status"]] ??
           LightsparkNodeStatus.FUTURE_VALUE
-        : null
+        : null,
     );
   }
   throw new LightsparkException(
     "DeserializationError",
-    `Couldn't find a concrete type for interface Node corresponding to the typename=${obj["__typename"]}`
+    `Couldn't find a concrete type for interface Node corresponding to the typename=${obj["__typename"]}`,
   );
 };
 

package/src/objects/NodeAddress.ts

@@ -2,7 +2,7 @@
 
 import NodeAddressType from "./NodeAddressType.js";
 
-/** 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;

package/src/objects/NodeAddressType.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** 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. **/
 export enum NodeAddressType {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/NodeToAddressesConnection.ts

@@ -16,12 +16,12 @@ type NodeToAddressesConnection = {
 };
 
 export const NodeToAddressesConnectionFromJson = (
-  obj: any
+  obj: any,
 ): NodeToAddressesConnection => {
   return {
     count: obj["node_to_addresses_connection_count"],
     entities: obj["node_to_addresses_connection_entities"].map((e) =>
-      NodeAddressFromJson(e)
+      NodeAddressFromJson(e),
     ),
   } as NodeToAddressesConnection;
 };

package/src/objects/OnChainTransaction.ts

@@ -1,7 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
-import { LightsparkException } from "@lightsparkdev/core";
+import { LightsparkException, type Query } from "@lightsparkdev/core";
 import type ChannelClosingTransaction from "./ChannelClosingTransaction.js";
 import type ChannelOpeningTransaction from "./ChannelOpeningTransaction.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
@@ -12,7 +11,7 @@ import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 import type Withdrawal from "./Withdrawal.js";
 
-/** 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 & {
     /**
@@ -160,7 +159,7 @@ export const OnChainTransactionFromJson = (obj: any): OnChainTransaction => {
   }
   throw new LightsparkException(
     "DeserializationError",
-    `Couldn't find a concrete type for interface OnChainTransaction corresponding to the typename=${obj["__typename"]}`
+    `Couldn't find a concrete type for interface OnChainTransaction corresponding to the typename=${obj["__typename"]}`,
   );
 };
 
@@ -298,7 +297,7 @@ fragment OnChainTransactionFragment on OnChainTransaction {
 }`;
 
 export const getOnChainTransactionQuery = (
-  id: string
+  id: string,
 ): Query<OnChainTransaction> => {
   return {
     queryPayload: `

package/src/objects/OutgoingPayment.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
@@ -15,7 +15,7 @@ import type RichText from "./RichText.js";
 import { RichTextFromJson } from "./RichText.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** 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. **/
 class OutgoingPayment implements LightningTransaction {
   constructor(
     public readonly id: string,
@@ -31,23 +31,31 @@ class OutgoingPayment implements LightningTransaction {
     public readonly fees?: CurrencyAmount,
     public readonly paymentRequestData?: PaymentRequestData,
     public readonly failureReason?: PaymentFailureReason,
-    public readonly failureMessage?: RichText
+    public readonly failureMessage?: RichText,
   ) {
     autoBind(this);
   }
 
   public async getAttempts(
     client: LightsparkClient,
-    first: number | undefined = undefined
+    first: number | undefined = undefined,
+    after: string | undefined = undefined,
   ): Promise<OutgoingPaymentToAttemptsConnection> {
     return (await client.executeRawQuery({
       queryPayload: ` 
-query FetchOutgoingPaymentToAttemptsConnection($entity_id: ID!, $first: Int) {
+query FetchOutgoingPaymentToAttemptsConnection($entity_id: ID!, $first: Int, $after: String) {
     entity(id: $entity_id) {
         ... on OutgoingPayment {
-            attempts(, first: $first) {
+            attempts(, first: $first, after: $after) {
                 __typename
                 outgoing_payment_to_attempts_connection_count: count
+                outgoing_payment_to_attempts_connection_page_info: page_info {
+                    __typename
+                    page_info_has_next_page: has_next_page
+                    page_info_has_previous_page: has_previous_page
+                    page_info_start_cursor: start_cursor
+                    page_info_end_cursor: end_cursor
+                }
                 outgoing_payment_to_attempts_connection_entities: entities {
                     __typename
                     outgoing_payment_attempt_id: id
@@ -82,7 +90,7 @@ query FetchOutgoingPaymentToAttemptsConnection($entity_id: ID!, $first: Int) {
     }
 }
 `,
-      variables: { entity_id: this.id, first: first },
+      variables: { entity_id: this.id, first: first, after: after },
       constructObject: (json) => {
         const connection = json["entity"]["attempts"];
         return OutgoingPaymentToAttemptsConnectionFromJson(connection);
@@ -134,7 +142,7 @@ export const OutgoingPaymentFromJson = (obj: any): OutgoingPayment => {
       : null,
     !!obj["outgoing_payment_failure_message"]
       ? RichTextFromJson(obj["outgoing_payment_failure_message"])
-      : undefined
+      : undefined,
   );
 };
 

package/src/objects/OutgoingPaymentAttempt.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
@@ -11,7 +11,7 @@ import OutgoingPaymentAttemptStatus from "./OutgoingPaymentAttemptStatus.js";
 import type OutgoingPaymentAttemptToHopsConnection from "./OutgoingPaymentAttemptToHopsConnection.js";
 import { OutgoingPaymentAttemptToHopsConnectionFromJson } from "./OutgoingPaymentAttemptToHopsConnection.js";
 
-/** 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. **/
 class OutgoingPaymentAttempt implements Entity {
   constructor(
     public readonly id: string,
@@ -24,23 +24,31 @@ class OutgoingPaymentAttempt implements Entity {
     public readonly failureSourceIndex?: number,
     public readonly resolvedAt?: string,
     public readonly amount?: CurrencyAmount,
-    public readonly fees?: CurrencyAmount
+    public readonly fees?: CurrencyAmount,
   ) {
     autoBind(this);
   }
 
   public async getHops(
     client: LightsparkClient,
-    first: number | undefined = undefined
+    first: number | undefined = undefined,
+    after: string | undefined = undefined,
   ): Promise<OutgoingPaymentAttemptToHopsConnection> {
     return (await client.executeRawQuery({
       queryPayload: ` 
-query FetchOutgoingPaymentAttemptToHopsConnection($entity_id: ID!, $first: Int) {
+query FetchOutgoingPaymentAttemptToHopsConnection($entity_id: ID!, $first: Int, $after: String) {
     entity(id: $entity_id) {
         ... on OutgoingPaymentAttempt {
-            hops(, first: $first) {
+            hops(, first: $first, after: $after) {
                 __typename
                 outgoing_payment_attempt_to_hops_connection_count: count
+                outgoing_payment_attempt_to_hops_connection_page_info: page_info {
+                    __typename
+                    page_info_has_next_page: has_next_page
+                    page_info_has_previous_page: has_previous_page
+                    page_info_start_cursor: start_cursor
+                    page_info_end_cursor: end_cursor
+                }
                 outgoing_payment_attempt_to_hops_connection_entities: entities {
                     __typename
                     hop_id: id
@@ -74,7 +82,7 @@ query FetchOutgoingPaymentAttemptToHopsConnection($entity_id: ID!, $first: Int)
     }
 }
 `,
-      variables: { entity_id: this.id, first: first },
+      variables: { entity_id: this.id, first: first, after: after },
       constructObject: (json) => {
         const connection = json["entity"]["hops"];
         return OutgoingPaymentAttemptToHopsConnectionFromJson(connection);
@@ -83,7 +91,7 @@ query FetchOutgoingPaymentAttemptToHopsConnection($entity_id: ID!, $first: Int)
   }
 
   static getOutgoingPaymentAttemptQuery(
-    id: string
+    id: string,
   ): Query<OutgoingPaymentAttempt> {
     return {
       queryPayload: `
@@ -105,7 +113,7 @@ ${FRAGMENT}
 }
 
 export const OutgoingPaymentAttemptFromJson = (
-  obj: any
+  obj: any,
 ): OutgoingPaymentAttempt => {
   return new OutgoingPaymentAttempt(
     obj["outgoing_payment_attempt_id"],
@@ -126,7 +134,7 @@ export const OutgoingPaymentAttemptFromJson = (
       : undefined,
     !!obj["outgoing_payment_attempt_fees"]
       ? CurrencyAmountFromJson(obj["outgoing_payment_attempt_fees"])
-      : undefined
+      : undefined,
   );
 };
 

package/src/objects/OutgoingPaymentAttemptStatus.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** 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. **/
 export enum OutgoingPaymentAttemptStatus {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts

@@ -1,28 +1,41 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+import type Connection from "./Connection.js";
 import type Hop from "./Hop.js";
 import { HopFromJson } from "./Hop.js";
+import type PageInfo from "./PageInfo.js";
+import { PageInfoFromJson } from "./PageInfo.js";
 
 /** 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;
 };
 
 export const OutgoingPaymentAttemptToHopsConnectionFromJson = (
-  obj: any
+  obj: any,
 ): OutgoingPaymentAttemptToHopsConnection => {
   return {
     count: obj["outgoing_payment_attempt_to_hops_connection_count"],
+    pageInfo: PageInfoFromJson(
+      obj["outgoing_payment_attempt_to_hops_connection_page_info"],
+    ),
     entities: obj["outgoing_payment_attempt_to_hops_connection_entities"].map(
-      (e) => HopFromJson(e)
+      (e) => HopFromJson(e),
     ),
+    typename: "OutgoingPaymentAttemptToHopsConnection",
   } as OutgoingPaymentAttemptToHopsConnection;
 };
 
@@ -30,6 +43,13 @@ export const FRAGMENT = `
 fragment OutgoingPaymentAttemptToHopsConnectionFragment on OutgoingPaymentAttemptToHopsConnection {
     __typename
     outgoing_payment_attempt_to_hops_connection_count: count
+    outgoing_payment_attempt_to_hops_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
     outgoing_payment_attempt_to_hops_connection_entities: entities {
         id
     }

package/src/objects/OutgoingPaymentToAttemptsConnection.ts

@@ -1,28 +1,41 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+import type Connection from "./Connection.js";
 import type OutgoingPaymentAttempt from "./OutgoingPaymentAttempt.js";
 import { OutgoingPaymentAttemptFromJson } from "./OutgoingPaymentAttempt.js";
+import type PageInfo from "./PageInfo.js";
+import { PageInfoFromJson } from "./PageInfo.js";
 
 /** 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;
 };
 
 export const OutgoingPaymentToAttemptsConnectionFromJson = (
-  obj: any
+  obj: any,
 ): OutgoingPaymentToAttemptsConnection => {
   return {
     count: obj["outgoing_payment_to_attempts_connection_count"],
+    pageInfo: PageInfoFromJson(
+      obj["outgoing_payment_to_attempts_connection_page_info"],
+    ),
     entities: obj["outgoing_payment_to_attempts_connection_entities"].map((e) =>
-      OutgoingPaymentAttemptFromJson(e)
+      OutgoingPaymentAttemptFromJson(e),
     ),
+    typename: "OutgoingPaymentToAttemptsConnection",
   } as OutgoingPaymentToAttemptsConnection;
 };
 
@@ -30,6 +43,13 @@ export const FRAGMENT = `
 fragment OutgoingPaymentToAttemptsConnectionFragment on OutgoingPaymentToAttemptsConnection {
     __typename
     outgoing_payment_to_attempts_connection_count: count
+    outgoing_payment_to_attempts_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
     outgoing_payment_to_attempts_connection_entities: entities {
         id
     }

package/src/objects/PageInfo.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** 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;
 

package/src/objects/PaymentFailureReason.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed. **/
 export enum PaymentFailureReason {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/PaymentRequest.ts

@@ -1,7 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
-import { LightsparkException } from "@lightsparkdev/core";
+import { LightsparkException, type Query } from "@lightsparkdev/core";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
 import type Invoice from "./Invoice.js";
@@ -9,6 +8,7 @@ import { InvoiceDataFromJson } from "./InvoiceData.js";
 import type PaymentRequestData from "./PaymentRequestData.js";
 import PaymentRequestStatus from "./PaymentRequestStatus.js";
 
+/** 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
@@ -50,7 +50,7 @@ export const PaymentRequestFromJson = (obj: any): PaymentRequest => {
   }
   throw new LightsparkException(
     "DeserializationError",
-    `Couldn't find a concrete type for interface PaymentRequest corresponding to the typename=${obj["__typename"]}`
+    `Couldn't find a concrete type for interface PaymentRequest corresponding to the typename=${obj["__typename"]}`,
   );
 };
 

package/src/objects/PaymentRequestData.ts

@@ -6,7 +6,7 @@ import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type InvoiceData from "./InvoiceData.js";
 import { NodeFromJson } from "./Node.js";
 
-/** 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;
 
@@ -34,7 +34,7 @@ export const PaymentRequestDataFromJson = (obj: any): PaymentRequestData => {
   }
   throw new LightsparkException(
     "DeserializationError",
-    `Couldn't find a concrete type for interface PaymentRequestData corresponding to the typename=${obj["__typename"]}`
+    `Couldn't find a concrete type for interface PaymentRequestData corresponding to the typename=${obj["__typename"]}`,
   );
 };
 

package/src/objects/PaymentRequestStatus.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential states that a payment request on the Lightning Network can take. **/
 export enum PaymentRequestStatus {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/Permission.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential permissions that a Lightspark user can have in regards to account management. **/
 export enum Permission {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/RequestWithdrawalInput.ts

@@ -20,7 +20,7 @@ type RequestWithdrawalInput = {
 };
 
 export const RequestWithdrawalInputFromJson = (
-  obj: any
+  obj: any,
 ): RequestWithdrawalInput => {
   return {
     nodeId: obj["request_withdrawal_input_node_id"],

package/src/objects/RequestWithdrawalOutput.ts

@@ -6,7 +6,7 @@ type RequestWithdrawalOutput = {
 };
 
 export const RequestWithdrawalOutputFromJson = (
-  obj: any
+  obj: any,
 ): RequestWithdrawalOutput => {
   return {
     requestId: obj["request_withdrawal_output_request"].id,

package/src/objects/RiskRating.ts

@@ -0,0 +1,18 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** 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. **/
+export 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",
+}
+
+export default RiskRating;