From 1b4fc3c0859d9ddbd71ac4a4af1b52b16c37ef9a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 26 Feb 2024 07:03:00 +0000 Subject: [PATCH] docs: admin api reference update to galoy commit 307bf38 --- static/admin-api-reference.html | 268 +++++++++++++++++++++++++++----- 1 file changed, 230 insertions(+), 38 deletions(-) diff --git a/static/admin-api-reference.html b/static/admin-api-reference.html index 2e57755..5bd1764 100644 --- a/static/admin-api-reference.html +++ b/static/admin-api-reference.html @@ -47,6 +47,7 @@
  • merchantsPendingApproval
  • transactionById
  • transactionsByHash
    • +
  • transactionsByPaymentRequest
  • wallet
    • @@ -255,7 +256,7 @@
    Response
    "data": { "accountDetailsByAccountId": { "createdAt": 1592577642, - "id": 4, + "id": "4", "level": "ONE", "merchants": [Merchant], "owner": AuditedUser, @@ -352,7 +353,7 @@
    Response
    "data": { "accountDetailsByEmail": { "createdAt": 1592577642, - "id": 4, + "id": "4", "level": "ONE", "merchants": [Merchant], "owner": AuditedUser, @@ -436,7 +437,7 @@
    Query
    Variables
    - 
    {"userId": 4}
+                    
    {"userId": "4"}
 
    
                     
                   
@@ -775,9 +776,9 @@ 
    Response
    
     "lightningInvoice": {
       "confirmedAt": 1592577642,
       "createdAt": 1592577642,
-      "description": "xyz789",
+      "description": "abc123",
       "expiresAt": 1592577642,
-      "isSettled": true,
+      "isSettled": false,
       "received": SatAmount,
       "request": LnPaymentRequest,
       "secretPreImage": LnPaymentPreImage
@@ -998,7 +999,7 @@ 
    Response
    
       {
         "coordinates": Coordinates,
         "createdAt": 1592577642,
-        "id": "4",
+        "id": 4,
         "title": "xyz789",
         "username": Username,
         "validated": true
@@ -1116,7 +1117,7 @@ 
    Response
    
     "transactionById": {
       "createdAt": 1592577642,
       "direction": "RECEIVE",
-      "id": 4,
+      "id": "4",
       "initiationVia": InitiationViaIntraLedger,
       "memo": Memo,
       "settlementAmount": SignedAmount,
@@ -1258,6 +1259,133 @@ 
    Response
    
     ]
   }
 }
+
    + + + + + + +
    +
    + Queries +
    +

    + transactionsByPaymentRequest +

    +
    +
    +
    +
    Response
    +

    Returns [Transaction] +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + paymentRequest - LnPaymentRequest! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + + + 
    query transactionsByPaymentRequest($paymentRequest: LnPaymentRequest!) {
+  transactionsByPaymentRequest(paymentRequest: $paymentRequest) {
+    createdAt
+    direction
+    id
+    initiationVia {
+      ... on InitiationViaIntraLedger {
+        ...InitiationViaIntraLedgerFragment
+      }
+      ... on InitiationViaLn {
+        ...InitiationViaLnFragment
+      }
+      ... on InitiationViaOnChain {
+        ...InitiationViaOnChainFragment
+      }
+    }
+    memo
+    settlementAmount
+    settlementCurrency
+    settlementDisplayAmount
+    settlementDisplayCurrency
+    settlementDisplayFee
+    settlementFee
+    settlementPrice {
+      ...PriceOfOneSettlementMinorUnitInDisplayMinorUnitFragment
+    }
+    settlementVia {
+      ... on SettlementViaIntraLedger {
+        ...SettlementViaIntraLedgerFragment
+      }
+      ... on SettlementViaLn {
+        ...SettlementViaLnFragment
+      }
+      ... on SettlementViaOnChain {
+        ...SettlementViaOnChainFragment
+      }
+    }
+    status
+  }
+}
+
    + + +
    +
    +
    Variables
    + + + 
    {"paymentRequest": LnPaymentRequest}
+
    + + +
    +
    +
    Response
    + + + 
    {
+  "data": {
+    "transactionsByPaymentRequest": [
+      {
+        "createdAt": 1592577642,
+        "direction": "RECEIVE",
+        "id": 4,
+        "initiationVia": InitiationViaIntraLedger,
+        "memo": Memo,
+        "settlementAmount": SignedAmount,
+        "settlementCurrency": "BTC",
+        "settlementDisplayAmount": SignedDisplayMajorAmount,
+        "settlementDisplayCurrency": DisplayCurrency,
+        "settlementDisplayFee": SignedDisplayMajorAmount,
+        "settlementFee": SignedAmount,
+        "settlementPrice": PriceOfOneSettlementMinorUnitInDisplayMinorUnit,
+        "settlementVia": SettlementViaIntraLedger,
+        "status": "FAILURE"
+      }
+    ]
+  }
+}
    @@ -1336,6 +1464,9 @@
    Query
    transactionsByPaymentHash { ...TransactionFragment } + transactionsByPaymentRequest { + ...TransactionFragment + } walletCurrency } } @@ -1359,9 +1490,9 @@
    Response
    {
   "data": {
     "wallet": {
-      "accountId": "4",
+      "accountId": 4,
       "balance": SignedAmount,
-      "id": "4",
+      "id": 4,
       "invoiceByPaymentHash": Invoice,
       "invoices": InvoiceConnection,
       "pendingIncomingBalance": SignedAmount,
@@ -1373,6 +1504,7 @@ 
    Response
    
       "transactions": TransactionConnection,
       "transactionsByAddress": TransactionConnection,
       "transactionsByPaymentHash": [Transaction],
+      "transactionsByPaymentRequest": [Transaction],
       "walletCurrency": "BTC"
     }
   }
@@ -1618,7 +1750,7 @@ 
    Response
    
   "data": {
     "adminPushNotificationSend": {
       "errors": [Error],
-      "success": false
+      "success": true
     }
   }
 }
@@ -2243,8 +2375,8 @@ 
    Example
    
                   
                     
                     
    {
-  "accountId": "abc123",
-  "body": "abc123",
+  "accountId": "xyz789",
+  "body": "xyz789",
   "data": Object,
   "notificationCategory": NotificationCategory,
   "title": "xyz789"
@@ -2455,7 +2587,7 @@ 
    Example
    
                     
    {
   "createdAt": 1592577642,
   "email": Email,
-  "id": "4",
+  "id": 4,
   "language": Language,
   "phone": Phone
 }
@@ -2700,6 +2832,25 @@ 
    paymentHash
                         
                       
+                      
+                        transactionsByPaymentRequest - [Transaction!]!
+                        
+                        
+                        
+                      
+                      
+                        
+                          
    
+                            
     Arguments 
    
+                            
    
+                              
    
+                                
    paymentRequest - LnPaymentRequest!
+                                
    
+                              
    
+                            
    
+                          
    
+                        
+                      
                       
                         walletCurrency - WalletCurrency!
                         
@@ -2716,9 +2867,9 @@ 
    Example
    
                   
                     
                     
    {
-  "accountId": 4,
+  "accountId": "4",
   "balance": SignedAmount,
-  "id": "4",
+  "id": 4,
   "invoiceByPaymentHash": Invoice,
   "invoices": InvoiceConnection,
   "pendingIncomingBalance": SignedAmount,
@@ -2728,6 +2879,7 @@ 
    Example
    
   "transactions": TransactionConnection,
   "transactionsByAddress": TransactionConnection,
   "transactionsByPaymentHash": [Transaction],
+  "transactionsByPaymentRequest": [Transaction],
   "walletCurrency": "BTC"
 }
 
    
@@ -2791,7 +2943,7 @@ 
    Fields
    
                   
    Example
    
                   
                     
-                    
    {"latitude": 987.65, "longitude": 123.45}
+                    
    {"latitude": 123.45, "longitude": 123.45}
 
    
                     
                   
@@ -2864,7 +3016,7 @@ 
    Example
    
                     
                     
    {
   "address": "test@test.com",
-  "verified": false
+  "verified": true
 }
 
    
                     
@@ -2961,7 +3113,7 @@ 
    Example
    
                     
                     
    {
   "code": "xyz789",
-  "message": "abc123",
+  "message": "xyz789",
   "path": ["abc123"]
 }
 
    
@@ -2988,7 +3140,7 @@ 
    Description
    
                   
    Example
    
                   
                     
-                    
    123.45
+                    
    987.65
 
    
                     
                   
@@ -3042,7 +3194,7 @@ 
    Example
    
                     
                     
    {
   "code": "xyz789",
-  "message": "abc123",
+  "message": "xyz789",
   "path": ["abc123"]
 }
 
    
@@ -3279,7 +3431,7 @@ 
    Description
    
                   
    Example
    
                   
                     
-                    
    123
+                    
    987
 
    
                     
                   
@@ -3449,7 +3601,7 @@ 
    Example
    
                   
                     
                     
    {
-  "cursor": "xyz789",
+  "cursor": "abc123",
   "node": Invoice
 }
 
    
@@ -3612,7 +3764,7 @@ 
    Example
    
                     
    {
   "confirmedAt": 1592577642,
   "createdAt": 1592577642,
-  "description": "xyz789",
+  "description": "abc123",
   "expiresAt": 1592577642,
   "isSettled": false,
   "received": SatAmount,
@@ -3947,10 +4099,10 @@ 
    Example
    
                     
    {
   "coordinates": Coordinates,
   "createdAt": 1592577642,
-  "id": 4,
-  "title": "xyz789",
+  "id": "4",
+  "title": "abc123",
   "username": Username,
-  "validated": true
+  "validated": false
 }
 
    
                     
@@ -3992,7 +4144,7 @@ 
    Fields
    
                   
    Example
    
                   
                     
-                    
    {"id": "4"}
+                    
    {"id": 4}
 
    
                     
                   
@@ -4033,7 +4185,7 @@ 
    Fields
    
                   
    Example
    
                   
                     
-                    
    {"id": "4"}
+                    
    {"id": 4}
 
    
                     
                   
@@ -4229,8 +4381,8 @@ 
    Example
    
                   
                     
                     
    {
-  "endCursor": "xyz789",
-  "hasNextPage": false,
+  "endCursor": "abc123",
+  "hasNextPage": true,
   "hasPreviousPage": true,
   "startCursor": "xyz789"
 }
@@ -4351,8 +4503,8 @@ 
    Example
    
                     
                     
    {
   "base": 9007199254740991,
-  "currencyUnit": "abc123",
-  "offset": 123
+  "currencyUnit": "xyz789",
+  "offset": 987
 }
 
    
                     
@@ -4420,8 +4572,8 @@ 
    Example
    
                     
    {
   "base": 9007199254740991,
   "currencyUnit": "abc123",
-  "formattedAmount": "xyz789",
-  "offset": 123
+  "formattedAmount": "abc123",
+  "offset": 987
 }
 
    
                     
@@ -4680,7 +4832,7 @@ 
    Example
    
                     
    {
   "arrivalInMempoolEstimatedAt": 1592577642,
   "transactionHash": OnChainTxHash,
-  "vout": 123
+  "vout": 987
 }
 
    
                     
@@ -4756,7 +4908,7 @@ 
    Description
    
                   
    Example
    
                   
                     
-                    
    "abc123"
+                    
    "xyz789"
 
    
                     
                   
@@ -5362,6 +5514,25 @@ 
    paymentHash
                         
                       
+                      
+                        transactionsByPaymentRequest - [Transaction!]!
+                        
+                        
+                        
+                      
+                      
+                        
+                          
    
+                            
     Arguments 
    
+                            
    
+                              
    
+                                
    paymentRequest - LnPaymentRequest!
+                                
    
+                              
    
+                            
    
+                          
    
+                        
+                      
                       
                         walletCurrency - WalletCurrency!
                         
@@ -5390,6 +5561,7 @@ 
    Example
    
   "transactions": TransactionConnection,
   "transactionsByAddress": TransactionConnection,
   "transactionsByPaymentHash": [Transaction],
+  "transactionsByPaymentRequest": [Transaction],
   "walletCurrency": "BTC"
 }
 
    
@@ -5710,6 +5882,25 @@ 
    paymentHash
                         
                       
+                      
+                        transactionsByPaymentRequest - [Transaction!]!
+                        
+                         Returns the transactions that include this paymentRequest. 
+                      
+                      
+                        
+                          
    
+                            
     Arguments 
    
+                            
    
+                              
    
+                                
    paymentRequest - LnPaymentRequest!
+                                
    
+                                
    Lightning invoice paid in this transaction.
    
+                              
    
+                            
    
+                          
    
+                        
+                      
                       
                         walletCurrency - WalletCurrency!
                         
@@ -5748,9 +5939,9 @@ 
    Example
    
                   
                     
                     
    {
-  "accountId": "4",
+  "accountId": 4,
   "balance": SignedAmount,
-  "id": "4",
+  "id": 4,
   "invoiceByPaymentHash": Invoice,
   "invoices": InvoiceConnection,
   "pendingIncomingBalance": SignedAmount,
@@ -5760,6 +5951,7 @@ 
    Example
    
   "transactions": TransactionConnection,
   "transactionsByAddress": TransactionConnection,
   "transactionsByPaymentHash": [Transaction],
+  "transactionsByPaymentRequest": [Transaction],
   "walletCurrency": "BTC"
 }