Merge branch 'master' into feat/decode-invoice-v2

getAlby · Nov 17, 2023 · 128146c · 128146c
2 parents 0cb5917 + ddd7df4
commit 128146c
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -221,7 +221,7 @@ Please have a look a the Alby OAuth2 Wallet API:
 - keysend
 - sendPayment
 - sendBoostagram
-- sendToAlbyAccount
+- sendBoostagramToAlbyAccount
 - createWebhookEndpoint
 - deleteWebhookEndpoint
 

diff --git a/src/client.ts b/src/client.ts
@@ -18,7 +18,7 @@ import {
   SendBoostagramRequestParams,
   SendPaymentRequestParams,
   SendPaymentResponse,
-  SendToAlbyRequestParams,
+  SendBoostagramToAlbyRequestParams,
   SwapInfoResponse,
 } from "./types";
 
@@ -239,8 +239,18 @@ export class Client {
     });
   }
 
+  /**
+   * @deprecated please use sendBoostagramToAlbyAccount
+   */
   sendToAlbyAccount(
-    args: SendToAlbyRequestParams,
+    args: SendBoostagramToAlbyRequestParams,
+    request_options?: Partial<RequestOptions>,
+  ) {
+    return this.sendBoostagramToAlbyAccount(args, request_options);
+  }
+
+  sendBoostagramToAlbyAccount(
+    args: SendBoostagramToAlbyRequestParams,
     request_options?: Partial<RequestOptions>,
   ) {
     const params = {

diff --git a/src/types.ts b/src/types.ts
@@ -123,12 +123,20 @@ export type SendBoostagramRequestParams = {
   amount: number;
 };
 
-export type SendToAlbyRequestParams = {
+export type SendBoostagramToAlbyRequestParams = {
+  /**
+   * the keysend custom value found at https://getalby.com/node
+   */
   account: string;
   amount: number;
   memo?: string;
 };
 
+/**
+ * @deprecated please use SendBoostagramToAlbyRequestParams
+ */
+export type SendToAlbyRequestParams = SendBoostagramToAlbyRequestParams;
+
 export type CreateWebhookEndpointParams = {
   url: string;
   description?: string;