@lightsparkdev/lightspark-sdk 0.4.8 → 0.4.10

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

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;
 

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/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;

package/src/objects/RoutingTransaction.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 type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
@@ -11,7 +11,7 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
 import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** A transaction that was forwarded through a Lightspark node on the Lightning Network. **/
+/** 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 & {

package/src/objects/RoutingTransactionFailureReason.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential reasons that an attempted routed transaction through a Lightspark node may have failed. **/
 export enum RoutingTransactionFailureReason {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/ScreenBitcoinAddressesInput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CryptoSanctionsScreeningProvider from "./CryptoSanctionsScreeningProvider.js";
+
+type ScreenBitcoinAddressesInput = {
+  provider: CryptoSanctionsScreeningProvider;
+
+  addresses: string[];
+};
+
+export const ScreenBitcoinAddressesInputFromJson = (
+  obj: any
+): ScreenBitcoinAddressesInput => {
+  return {
+    provider:
+      CryptoSanctionsScreeningProvider[
+        obj["screen_bitcoin_addresses_input_provider"]
+      ] ?? CryptoSanctionsScreeningProvider.FUTURE_VALUE,
+    addresses: obj["screen_bitcoin_addresses_input_addresses"],
+  } as ScreenBitcoinAddressesInput;
+};
+
+export default ScreenBitcoinAddressesInput;

package/src/objects/ScreenBitcoinAddressesOutput.ts

@@ -0,0 +1,25 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import RiskRating from "./RiskRating.js";
+
+type ScreenBitcoinAddressesOutput = {
+  ratings: RiskRating[];
+};
+
+export const ScreenBitcoinAddressesOutputFromJson = (
+  obj: any
+): ScreenBitcoinAddressesOutput => {
+  return {
+    ratings: obj["screen_bitcoin_addresses_output_ratings"].map(
+      (e) => RiskRating[e]
+    ),
+  } as ScreenBitcoinAddressesOutput;
+};
+
+export const FRAGMENT = `
+fragment ScreenBitcoinAddressesOutputFragment on ScreenBitcoinAddressesOutput {
+    __typename
+    screen_bitcoin_addresses_output_ratings: ratings
+}`;
+
+export default ScreenBitcoinAddressesOutput;

package/src/objects/Transaction.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";
@@ -18,6 +17,7 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
 import TransactionStatus from "./TransactionStatus.js";
 import type Withdrawal from "./Withdrawal.js";
 
+/** 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

package/src/objects/TransactionFailures.ts

@@ -3,6 +3,7 @@
 import PaymentFailureReason from "./PaymentFailureReason.js";
 import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
 
+/** This object represents payment failures associated with your Lightspark Node. **/
 type TransactionFailures = {
   paymentFailures?: PaymentFailureReason[];
 

package/src/objects/TransactionStatus.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential statuses a transaction associated with your Lightspark Node can take. **/
 export enum TransactionStatus {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/TransactionType.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential types of transactions that can be associated with your Lightspark Node. **/
 export enum TransactionType {
   /**
    * This is an enum value that represents values that could be added in the future.