@lightsparkdev/lightspark-sdk 1.3.1 → 1.4.0

package/src/objects/Wallet.ts

@@ -16,18 +16,20 @@ import type WalletToPaymentRequestsConnection from "./WalletToPaymentRequestsCon
 import { WalletToPaymentRequestsConnectionFromJson } from "./WalletToPaymentRequestsConnection.js";
 import type WalletToTransactionsConnection from "./WalletToTransactionsConnection.js";
 import { WalletToTransactionsConnectionFromJson } from "./WalletToTransactionsConnection.js";
+import type WalletToWithdrawalRequestsConnection from "./WalletToWithdrawalRequestsConnection.js";
+import { WalletToWithdrawalRequestsConnectionFromJson } from "./WalletToWithdrawalRequestsConnection.js";
+import type WithdrawalRequestStatus from "./WithdrawalRequestStatus.js";
 
 /**
- * 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. *
+ * 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. *
  */
 class Wallet 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. **/
@@ -35,8 +37,7 @@ class Wallet implements LightsparkNodeOwner, Entity {
     /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
     /**
-     * The unique identifier of this wallet, as provided by the Lightspark Customer during login.
-     * *
+     * The unique identifier of this wallet, as provided by the Lightspark Customer during login. *
      */
     public readonly thirdPartyIdentifier: string,
     /** The status of this wallet. **/
@@ -1027,6 +1028,94 @@ query FetchWalletTotalAmountReceived($entity_id: ID!, $created_after_date: DateT
     }))!;
   }
 
+  public async getWithdrawalRequests(
+    client: LightsparkClient,
+    first: number | undefined = undefined,
+    after: string | undefined = undefined,
+    statuses: WithdrawalRequestStatus[] | undefined = undefined,
+    createdAfterDate: string | undefined = undefined,
+    createdBeforeDate: string | undefined = undefined,
+  ): Promise<WalletToWithdrawalRequestsConnection> {
+    return (await client.executeRawQuery({
+      queryPayload: ` 
+query FetchWalletToWithdrawalRequestsConnection($entity_id: ID!, $first: Int, $after: ID, $statuses: [WithdrawalRequestStatus!], $created_after_date: DateTime, $created_before_date: DateTime) {
+    entity(id: $entity_id) {
+        ... on Wallet {
+            withdrawal_requests(, first: $first, after: $after, statuses: $statuses, created_after_date: $created_after_date, created_before_date: $created_before_date) {
+                __typename
+                wallet_to_withdrawal_requests_connection_count: count
+                wallet_to_withdrawal_requests_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
+                }
+                wallet_to_withdrawal_requests_connection_entities: entities {
+                    __typename
+                    withdrawal_request_id: id
+                    withdrawal_request_created_at: created_at
+                    withdrawal_request_updated_at: updated_at
+                    withdrawal_request_requested_amount: requested_amount {
+                        __typename
+                        currency_amount_original_value: original_value
+                        currency_amount_original_unit: original_unit
+                        currency_amount_preferred_currency_unit: preferred_currency_unit
+                        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                    }
+                    withdrawal_request_amount: amount {
+                        __typename
+                        currency_amount_original_value: original_value
+                        currency_amount_original_unit: original_unit
+                        currency_amount_preferred_currency_unit: preferred_currency_unit
+                        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                    }
+                    withdrawal_request_estimated_amount: estimated_amount {
+                        __typename
+                        currency_amount_original_value: original_value
+                        currency_amount_original_unit: original_unit
+                        currency_amount_preferred_currency_unit: preferred_currency_unit
+                        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                    }
+                    withdrawal_request_amount_withdrawn: amount_withdrawn {
+                        __typename
+                        currency_amount_original_value: original_value
+                        currency_amount_original_unit: original_unit
+                        currency_amount_preferred_currency_unit: preferred_currency_unit
+                        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                    }
+                    withdrawal_request_bitcoin_address: bitcoin_address
+                    withdrawal_request_withdrawal_mode: withdrawal_mode
+                    withdrawal_request_status: status
+                    withdrawal_request_completed_at: completed_at
+                    withdrawal_request_withdrawal: withdrawal {
+                        id
+                    }
+                }
+            }
+        }
+    }
+}
+`,
+      variables: {
+        entity_id: this.id,
+        first: first,
+        after: after,
+        statuses: statuses,
+        created_after_date: createdAfterDate,
+        created_before_date: createdBeforeDate,
+      },
+      constructObject: (json) => {
+        const connection = json["entity"]["withdrawal_requests"];
+        return WalletToWithdrawalRequestsConnectionFromJson(connection);
+      },
+    }))!;
+  }
+
   public async getTotalAmountSent(
     client: LightsparkClient,
     createdAfterDate: string | undefined = undefined,

package/src/objects/WalletStatus.ts

@@ -8,16 +8,14 @@ export enum WalletStatus {
    */
   FUTURE_VALUE = "FUTURE_VALUE",
   /**
-   * The wallet has not been set up yet and is ready to be deployed.
-   * This is the default status after the first login.
-   * *
+   * The wallet has not been set up yet and is ready to be deployed. This is the default status
+   * after the first login. *
    */
   NOT_SETUP = "NOT_SETUP",
   /** The wallet is currently being deployed in the Lightspark infrastructure. **/
   DEPLOYING = "DEPLOYING",
   /**
-   * The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized.
-   * *
+   * The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized. *
    */
   DEPLOYED = "DEPLOYED",
   /** The wallet is currently being initialized. **/
@@ -35,8 +33,8 @@ export enum WalletStatus {
   TERMINATING = "TERMINATING",
   /**
    * The wallet has been terminated and is not available in the Lightspark infrastructure anymore.
-   * It is not connected to the Lightning network and its funds can only be accessed using the Funds
-   * Recovery flow. *
+   * It is not connected to the Lightning network and its funds can only be accessed using the
+   * Funds Recovery flow. *
    */
   TERMINATED = "TERMINATED",
 }

package/src/objects/WalletToPaymentRequestsConnection.ts

@@ -10,9 +10,8 @@ import {
 
 interface WalletToPaymentRequestsConnection {
   /**
-   * 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/WalletToTransactionsConnection.ts

@@ -7,9 +7,8 @@ import { TransactionFromJson, TransactionToJson } from "./Transaction.js";
 
 interface WalletToTransactionsConnection {
   /**
-   * 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/WalletToWithdrawalRequestsConnection.ts

@@ -0,0 +1,70 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import type PageInfo from "./PageInfo.js";
+import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
+import type WithdrawalRequest from "./WithdrawalRequest.js";
+import { WithdrawalRequestFromJson } from "./WithdrawalRequest.js";
+
+interface WalletToWithdrawalRequestsConnection {
+  /**
+   * 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 withdrawal requests for the current page of this connection. **/
+  entities: WithdrawalRequest[];
+
+  /** The typename of the object **/
+  typename: string;
+}
+
+export const WalletToWithdrawalRequestsConnectionFromJson = (
+  obj: any,
+): WalletToWithdrawalRequestsConnection => {
+  return {
+    count: obj["wallet_to_withdrawal_requests_connection_count"],
+    pageInfo: PageInfoFromJson(
+      obj["wallet_to_withdrawal_requests_connection_page_info"],
+    ),
+    entities: obj["wallet_to_withdrawal_requests_connection_entities"].map(
+      (e) => WithdrawalRequestFromJson(e),
+    ),
+    typename: "WalletToWithdrawalRequestsConnection",
+  } as WalletToWithdrawalRequestsConnection;
+};
+export const WalletToWithdrawalRequestsConnectionToJson = (
+  obj: WalletToWithdrawalRequestsConnection,
+): any => {
+  return {
+    __typename: "WalletToWithdrawalRequestsConnection",
+    wallet_to_withdrawal_requests_connection_count: obj.count,
+    wallet_to_withdrawal_requests_connection_page_info: PageInfoToJson(
+      obj.pageInfo,
+    ),
+    wallet_to_withdrawal_requests_connection_entities: obj.entities.map((e) =>
+      e.toJson(),
+    ),
+  };
+};
+
+export const FRAGMENT = `
+fragment WalletToWithdrawalRequestsConnectionFragment on WalletToWithdrawalRequestsConnection {
+    __typename
+    wallet_to_withdrawal_requests_connection_count: count
+    wallet_to_withdrawal_requests_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
+    }
+    wallet_to_withdrawal_requests_connection_entities: entities {
+        id
+    }
+}`;
+
+export default WalletToWithdrawalRequestsConnection;

package/src/objects/Withdrawal.ts

@@ -9,14 +9,14 @@ import {
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * 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. *
+ * 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. *
  */
 interface Withdrawal {
   /**
-   * 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/WithdrawalRequest.ts

@@ -19,21 +19,29 @@ import { WithdrawalRequestToChannelOpeningTransactionsConnectionFromJson } from
 /**
  * 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.
- * *
+ * withdrawal request made from your Lightspark account. *
  */
 class WithdrawalRequest 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. **/
     public readonly createdAt: string,
     /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
-    /** The amount of money that should be withdrawn in this request. **/
+    /**
+     * The requested amount of money to be withdrawn. If the requested amount is -1, it means to
+     * withdraw all.
+     **/
+    public readonly requestedAmount: CurrencyAmount,
+    /**
+     * The amount of money that should be withdrawn in this request.
+     *
+     * @deprecated Use `requested_amount` instead
+     **/
     public readonly amount: CurrencyAmount,
     /** The bitcoin address where the funds should be sent. **/
     public readonly bitcoinAddress: string,
@@ -44,10 +52,12 @@ class WithdrawalRequest implements Entity {
     /** The typename of the object **/
     public readonly typename: string,
     /**
-     * If the requested amount is `-1` (i.e. everything),
-     * this field may contain an estimate of the amount for the withdrawal.
+     * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the
+     * amount for the withdrawal.
      **/
     public readonly estimatedAmount?: CurrencyAmount | undefined,
+    /** The actual amount that is withdrawn. It will be set once the request is completed. **/
+    public readonly amountWithdrawn?: CurrencyAmount | undefined,
     /** The time at which this request was completed. **/
     public readonly completedAt?: string | undefined,
     /** The withdrawal transaction that has been generated by this request. **/
@@ -212,10 +222,16 @@ ${FRAGMENT}
       withdrawal_request_id: this.id,
       withdrawal_request_created_at: this.createdAt,
       withdrawal_request_updated_at: this.updatedAt,
+      withdrawal_request_requested_amount: CurrencyAmountToJson(
+        this.requestedAmount,
+      ),
       withdrawal_request_amount: CurrencyAmountToJson(this.amount),
       withdrawal_request_estimated_amount: this.estimatedAmount
         ? CurrencyAmountToJson(this.estimatedAmount)
         : undefined,
+      withdrawal_request_amount_withdrawn: this.amountWithdrawn
+        ? CurrencyAmountToJson(this.amountWithdrawn)
+        : undefined,
       withdrawal_request_bitcoin_address: this.bitcoinAddress,
       withdrawal_request_withdrawal_mode: this.withdrawalMode,
       withdrawal_request_status: this.status,
@@ -230,6 +246,7 @@ export const WithdrawalRequestFromJson = (obj: any): WithdrawalRequest => {
     obj["withdrawal_request_id"],
     obj["withdrawal_request_created_at"],
     obj["withdrawal_request_updated_at"],
+    CurrencyAmountFromJson(obj["withdrawal_request_requested_amount"]),
     CurrencyAmountFromJson(obj["withdrawal_request_amount"]),
     obj["withdrawal_request_bitcoin_address"],
     WithdrawalMode[obj["withdrawal_request_withdrawal_mode"]] ??
@@ -240,6 +257,9 @@ export const WithdrawalRequestFromJson = (obj: any): WithdrawalRequest => {
     !!obj["withdrawal_request_estimated_amount"]
       ? CurrencyAmountFromJson(obj["withdrawal_request_estimated_amount"])
       : undefined,
+    !!obj["withdrawal_request_amount_withdrawn"]
+      ? CurrencyAmountFromJson(obj["withdrawal_request_amount_withdrawn"])
+      : undefined,
     obj["withdrawal_request_completed_at"],
     obj["withdrawal_request_withdrawal"]?.id ?? undefined,
   );
@@ -251,6 +271,14 @@ fragment WithdrawalRequestFragment on WithdrawalRequest {
     withdrawal_request_id: id
     withdrawal_request_created_at: created_at
     withdrawal_request_updated_at: updated_at
+    withdrawal_request_requested_amount: requested_amount {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
     withdrawal_request_amount: amount {
         __typename
         currency_amount_original_value: original_value
@@ -267,6 +295,14 @@ fragment WithdrawalRequestFragment on WithdrawalRequest {
         currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
         currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
     }
+    withdrawal_request_amount_withdrawn: amount_withdrawn {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
     withdrawal_request_bitcoin_address: bitcoin_address
     withdrawal_request_withdrawal_mode: withdrawal_mode
     withdrawal_request_status: status

package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts

@@ -13,9 +13,8 @@ interface WithdrawalRequestToChannelClosingTransactionsConnection {
   pageInfo: PageInfo;
 
   /**
-   * 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/WithdrawalRequestToChannelOpeningTransactionsConnection.ts

@@ -13,9 +13,8 @@ interface WithdrawalRequestToChannelOpeningTransactionsConnection {
   pageInfo: PageInfo;
 
   /**
-   * 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/index.ts

@@ -5,6 +5,7 @@ export { default as AccountToNodesConnection } from "./AccountToNodesConnection.
 export { default as AccountToPaymentRequestsConnection } from "./AccountToPaymentRequestsConnection.js";
 export { default as AccountToTransactionsConnection } from "./AccountToTransactionsConnection.js";
 export { default as AccountToWalletsConnection } from "./AccountToWalletsConnection.js";
+export { default as AccountToWithdrawalRequestsConnection } from "./AccountToWithdrawalRequestsConnection.js";
 export { default as ApiToken, getApiTokenQuery } from "./ApiToken.js";
 export { default as Balances } from "./Balances.js";
 export { default as BitcoinNetwork } from "./BitcoinNetwork.js";
@@ -173,6 +174,7 @@ export { default as Wallet } from "./Wallet.js";
 export { default as WalletStatus } from "./WalletStatus.js";
 export { default as WalletToPaymentRequestsConnection } from "./WalletToPaymentRequestsConnection.js";
 export { default as WalletToTransactionsConnection } from "./WalletToTransactionsConnection.js";
+export { default as WalletToWithdrawalRequestsConnection } from "./WalletToWithdrawalRequestsConnection.js";
 export { default as WebhookEventType } from "./WebhookEventType.js";
 export { default as Withdrawal, getWithdrawalQuery } from "./Withdrawal.js";
 export { default as WithdrawalMode } from "./WithdrawalMode.js";