From 1ee44215eb18276952d37946595768effaf56c53 Mon Sep 17 00:00:00 2001 From: openoms Date: Tue, 14 Nov 2023 15:12:25 +0100 Subject: [PATCH] chore: update api reference --- docs/contribute/g-tiankii-merchant-tools.md | 5 - static/admin-api-reference.html | 78 +++++++-------- static/public-api-reference.html | 102 ++++++++++---------- 3 files changed, 88 insertions(+), 97 deletions(-) delete mode 100644 docs/contribute/g-tiankii-merchant-tools.md diff --git a/docs/contribute/g-tiankii-merchant-tools.md b/docs/contribute/g-tiankii-merchant-tools.md deleted file mode 100644 index f17e2bc..0000000 --- a/docs/contribute/g-tiankii-merchant-tools.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -slug: /projects/tiankii-merchant-tools ---- -# Tiankii merchant tools -Project website: [tiankii.com](https://www.tiankii.com/) \ No newline at end of file diff --git a/static/admin-api-reference.html b/static/admin-api-reference.html index aa47c84..df3bb9c 100644 --- a/static/admin-api-reference.html +++ b/static/admin-api-reference.html @@ -247,7 +247,7 @@
Query
Variables
- 
{"accountId": 4}
+                    
{"accountId": "4"}
 

                     
                   
@@ -261,7 +261,7 @@ 
Response

     "accountDetailsByAccountId": {
       "coordinates": Coordinates,
       "createdAt": 1592577642,
-      "id": "4",
+      "id": 4,
       "level": "ONE",
       "owner": AuditedUser,
       "status": "ACTIVE",
@@ -368,7 +368,7 @@ 
Response

       "status": "ACTIVE",
       "title": "xyz789",
       "username": Username,
-      "uuid": "abc123",
+      "uuid": "xyz789",
       "wallets": [Wallet]
     }
   }
@@ -463,13 +463,13 @@ 
Response

     "accountDetailsByUserPhone": {
       "coordinates": Coordinates,
       "createdAt": 1592577642,
-      "id": "4",
+      "id": 4,
       "level": "ONE",
       "owner": AuditedUser,
       "status": "ACTIVE",
-      "title": "xyz789",
+      "title": "abc123",
       "username": Username,
-      "uuid": "xyz789",
+      "uuid": "abc123",
       "wallets": [Wallet]
     }
   }
@@ -564,11 +564,11 @@ 
Response

     "accountDetailsByUsername": {
       "coordinates": Coordinates,
       "createdAt": 1592577642,
-      "id": "4",
+      "id": 4,
       "level": "ONE",
       "owner": AuditedUser,
       "status": "ACTIVE",
-      "title": "xyz789",
+      "title": "abc123",
       "username": Username,
       "uuid": "abc123",
       "wallets": [Wallet]
@@ -699,7 +699,7 @@ 
Response

       "createdAt": 1592577642,
       "description": "xyz789",
       "expiresAt": 1592577642,
-      "isSettled": false,
+      "isSettled": true,
       "received": SatAmount,
       "request": LnPaymentRequest,
       "secretPreImage": LnPaymentPreImage
@@ -976,7 +976,7 @@ 
Response

     "transactionById": {
       "createdAt": 1592577642,
       "direction": "RECEIVE",
-      "id": "4",
+      "id": 4,
       "initiationVia": InitiationViaIntraLedger,
       "memo": Memo,
       "settlementAmount": SignedAmount,
@@ -1201,7 +1201,7 @@ 
Response

                     
{
   "data": {
     "wallet": {
-      "accountId": "4",
+      "accountId": 4,
       "balance": SignedAmount,
       "id": 4,
       "pendingIncomingBalance": SignedAmount,
@@ -1917,7 +1917,7 @@ 
Response

   "data": {
     "userRequestAuthCode": {
       "errors": [Error],
-      "success": true
+      "success": false
     }
   }
 }
@@ -2278,9 +2278,9 @@ 
Example

                   
                     
                     
{
-  "comment": "abc123",
+  "comment": "xyz789",
   "status": "ACTIVE",
-  "uid": "4"
+  "uid": 4
 }
 

                     
@@ -2337,9 +2337,9 @@ 
Example

                   
                     
                     
{
-  "accountId": "abc123",
+  "accountId": "xyz789",
   "body": "xyz789",
-  "title": "xyz789"
+  "title": "abc123"
 }
 

                     
@@ -2486,13 +2486,13 @@ 
Example

                     
{
   "coordinates": Coordinates,
   "createdAt": 1592577642,
-  "id": 4,
+  "id": "4",
   "level": "ONE",
   "owner": AuditedUser,
   "status": "ACTIVE",
   "title": "xyz789",
   "username": Username,
-  "uuid": "xyz789",
+  "uuid": "abc123",
   "wallets": [Wallet]
 }
 

@@ -2560,7 +2560,7 @@ 
Example

                     
{
   "createdAt": 1592577642,
   "email": Email,
-  "id": 4,
+  "id": "4",
   "language": Language,
   "phone": Phone
 }
@@ -2923,7 +2923,7 @@ 
Example

                     
{
   "latitude": 123.45,
   "longitude": 123.45,
-  "title": "abc123",
+  "title": "xyz789",
   "username": Username
 }
 

@@ -3033,10 +3033,10 @@ 
Example

                   
                     
                     
{
-  "challengeCode": "xyz789",
+  "challengeCode": "abc123",
   "failbackMode": false,
   "id": "xyz789",
-  "newCaptcha": false
+  "newCaptcha": true
 }
 

                     
@@ -3107,7 +3107,7 @@ 
Example

                   
                     
                     
{
-  "challengeCode": "xyz789",
+  "challengeCode": "abc123",
   "channel": "SMS",
   "phone": Phone,
   "secCode": "xyz789",
@@ -3158,7 +3158,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"latitude": 123.45, "longitude": 123.45}
+                    
{"latitude": 987.65, "longitude": 123.45}
 

                     
                   
@@ -3231,7 +3231,7 @@ 
Example

                     
                     
{
   "address": "test@test.com",
-  "verified": false
+  "verified": true
 }
 

                     
@@ -3327,7 +3327,7 @@ 
Example

                   
                     
                     
{
-  "code": "xyz789",
+  "code": "abc123",
   "message": "xyz789",
   "path": ["xyz789"]
 }
@@ -3355,7 +3355,7 @@ 
Description

                   
Example

                   
                     
-                    
123.45
+                    
987.65
 

                     
                   
@@ -3409,8 +3409,8 @@ 
Example

                     
                     
{
   "code": "abc123",
-  "message": "abc123",
-  "path": ["xyz789"]
+  "message": "xyz789",
+  "path": ["abc123"]
 }
 

                     
@@ -4139,9 +4139,9 @@ 
Example

                   
                     
                     
{
-  "endCursor": "abc123",
+  "endCursor": "xyz789",
   "hasNextPage": true,
-  "hasPreviousPage": false,
+  "hasPreviousPage": true,
   "startCursor": "xyz789"
 }
 

@@ -4309,8 +4309,8 @@ 
Example

                     
                     
{
   "base": 9007199254740991,
-  "currencyUnit": "abc123",
-  "offset": 123
+  "currencyUnit": "xyz789",
+  "offset": 987
 }
 

                     
@@ -4378,8 +4378,8 @@ 
Example

                     
{
   "base": 9007199254740991,
   "currencyUnit": "abc123",
-  "formattedAmount": "xyz789",
-  "offset": 987
+  "formattedAmount": "abc123",
+  "offset": 123
 }
 

                     
@@ -4697,7 +4697,7 @@ 
Description

                   
Example

                   
                     
-                    
"abc123"
+                    
"xyz789"
 

                     
                   
@@ -4743,7 +4743,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"errors": [Error], "success": false}
+                    
{"errors": [Error], "success": true}
 

                     
                   
@@ -5000,7 +5000,7 @@ 
Example

                   
                     
                     
{
-  "cursor": "xyz789",
+  "cursor": "abc123",
   "node": Transaction
 }
 

@@ -5591,7 +5591,7 @@ 
Example

                   
                     
                     
{
-  "accountId": "4",
+  "accountId": 4,
   "balance": SignedAmount,
   "id": 4,
   "pendingIncomingBalance": SignedAmount,
diff --git a/static/public-api-reference.html b/static/public-api-reference.html
index 375da7a..90797a8 100644
--- a/static/public-api-reference.html
+++ b/static/public-api-reference.html
@@ -412,14 +412,7 @@ 
Variables

                   
Response

                   
                     
-                    
{
-  "data": {
-    "accountDefaultWallet": {
-      "id": "4",
-      "walletCurrency": "BTC"
-    }
-  }
-}
+                    
{"data": {"accountDefaultWallet": {"id": 4, "walletCurrency": "BTC"}}}
 

                     
                   
@@ -505,7 +498,7 @@ 
Response

       "base": 9007199254740991,
       "currencyUnit": "abc123",
       "formattedAmount": "xyz789",
-      "offset": 123
+      "offset": 987
     }
   }
 }
@@ -693,10 +686,10 @@ 
Response

     "currencyList": [
       {
         "flag": "xyz789",
-        "fractionDigits": 123,
+        "fractionDigits": 987,
         "id": 4,
-        "name": "xyz789",
-        "symbol": "abc123"
+        "name": "abc123",
+        "symbol": "xyz789"
       }
     ]
   }
@@ -919,7 +912,7 @@ 
Response

       "createdAt": 1592577642,
       "defaultAccount": Account,
       "email": Email,
-      "id": "4",
+      "id": 4,
       "language": Language,
       "phone": Phone,
       "quizQuestions": [UserQuizQuestion],
@@ -975,8 +968,8 @@ 
Response

   "data": {
     "mobileVersions": [
       {
-        "currentSupported": 987,
-        "minSupported": 987,
+        "currentSupported": 123,
+        "minSupported": 123,
         "platform": "abc123"
       }
     ]
@@ -1968,7 +1961,7 @@ 
Response

   "data": {
     "captchaRequestAuthCode": {
       "errors": [Error],
-      "success": false
+      "success": true
     }
   }
 }
@@ -2128,7 +2121,10 @@ 
Response

                     
                     
{
   "data": {
-    "feedbackSubmit": {"errors": [Error], "success": true}
+    "feedbackSubmit": {
+      "errors": [Error],
+      "success": false
+    }
   }
 }
 

@@ -5856,10 +5852,10 @@ 
Example

                   
                     
                     
{
-  "csvTransactions": "abc123",
+  "csvTransactions": "xyz789",
   "defaultWalletId": WalletId,
   "displayCurrency": DisplayCurrency,
-  "id": 4,
+  "id": "4",
   "level": "ONE",
   "limits": AccountLimits,
   "realtimePrice": RealtimePrice,
@@ -5911,7 +5907,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"errors": [Error], "success": true}
+                    
{"errors": [Error], "success": false}
 

                     
                   
@@ -6349,7 +6345,7 @@ 
Example

                     
{
   "authToken": AuthToken,
   "errors": [Error],
-  "totpRequired": true
+  "totpRequired": false
 }
 

                     
@@ -6561,7 +6557,7 @@ 
Example

                   
                     
                     
{
-  "commitHash": "xyz789",
+  "commitHash": "abc123",
   "helmRevision": 987
 }
 

@@ -6671,10 +6667,10 @@ 
Example

                   
                     
                     
{
-  "challengeCode": "xyz789",
-  "failbackMode": true,
+  "challengeCode": "abc123",
+  "failbackMode": false,
   "id": "abc123",
-  "newCaptcha": true
+  "newCaptcha": false
 }
 

                     
@@ -6749,7 +6745,7 @@ 
Example

   "channel": "SMS",
   "phone": Phone,
   "secCode": "abc123",
-  "validationCode": "xyz789"
+  "validationCode": "abc123"
 }
 

                     
@@ -6965,7 +6961,7 @@ 
Example

   "csvTransactions": "xyz789",
   "defaultWalletId": WalletId,
   "displayCurrency": DisplayCurrency,
-  "id": 4,
+  "id": "4",
   "level": "ONE",
   "limits": AccountLimits,
   "quiz": [Quiz],
@@ -7182,10 +7178,10 @@ 
Example

                   
                     
                     
{
-  "flag": "abc123",
-  "fractionDigits": 987,
+  "flag": "xyz789",
+  "fractionDigits": 123,
   "id": "4",
-  "name": "xyz789",
+  "name": "abc123",
   "symbol": "xyz789"
 }
 

@@ -7238,7 +7234,7 @@ 
Example

                   
                     
                     
{
-  "minBankFee": "abc123",
+  "minBankFee": "xyz789",
   "minBankFeeThreshold": "xyz789",
   "ratio": "abc123"
 }
@@ -7282,7 +7278,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"deviceToken": "xyz789"}
+                    
{"deviceToken": "abc123"}
 

                     
                   
@@ -7478,7 +7474,7 @@ 
Example

                     
{
   "code": "xyz789",
   "message": "xyz789",
-  "path": ["abc123"]
+  "path": ["xyz789"]
 }
 

                     
@@ -7658,7 +7654,7 @@ 
Description

                   
Example

                   
                     
-                    
987.65
+                    
123.45
 

                     
                   
@@ -7737,7 +7733,7 @@ 
Example

                     
{
   "buildInformation": BuildInformation,
   "feesInformation": FeesInformation,
-  "lightningAddressDomain": "abc123",
+  "lightningAddressDomain": "xyz789",
   "lightningAddressDomainAliases": [
     "abc123"
   ],
@@ -7797,9 +7793,9 @@ 
Example

                   
                     
                     
{
-  "code": "abc123",
+  "code": "xyz789",
   "message": "xyz789",
-  "path": ["xyz789"]
+  "path": ["abc123"]
 }
 

                     
@@ -7850,7 +7846,7 @@ 
Description

                   
Example

                   
                     
-                    
"4"
+                    
4
 

                     
                   
@@ -8052,7 +8048,7 @@ 
Description

                   
Example

                   
                     
-                    
987
+                    
123
 

                     
                   
@@ -10303,7 +10299,7 @@ 
Example

   "displayCurrencyPerSat": 987.65,
   "txHash": OnChainTxHash,
   "txNotificationType": "IntraLedgerPayment",
-  "usdPerSat": 987.65,
+  "usdPerSat": 123.45,
   "walletId": WalletId
 }
 

@@ -10643,9 +10639,9 @@ 
Example

                     
                     
{
   "endCursor": "abc123",
-  "hasNextPage": true,
+  "hasNextPage": false,
   "hasPreviousPage": false,
-  "startCursor": "abc123"
+  "startCursor": "xyz789"
 }
 

                     
@@ -11170,8 +11166,8 @@ 
Example

                     
                     
{
   "base": 9007199254740991,
-  "currencyUnit": "abc123",
-  "offset": 123
+  "currencyUnit": "xyz789",
+  "offset": 987
 }
 

                     
@@ -11232,7 +11228,7 @@ 
Example

                     
{
   "base": 9007199254740991,
   "currencyUnit": "xyz789",
-  "offset": 987
+  "offset": 123
 }
 

                     
@@ -11555,7 +11551,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"amount": SatAmount, "completed": true, "id": 4}
+                    
{"amount": SatAmount, "completed": false, "id": 4}
 

                     
                   
@@ -12286,7 +12282,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"errors": [Error], "success": false}
+                    
{"errors": [Error], "success": true}
 

                     
                   
@@ -12879,7 +12875,7 @@ 
Example

                     
{
   "authToken": AuthToken,
   "errors": [Error],
-  "success": false
+  "success": true
 }
 

                     
@@ -13023,7 +13019,7 @@ 
Example

                   
                     
                     
{
-  "accountId": 4,
+  "accountId": "4",
   "balance": SignedAmount,
   "id": "4",
   "pendingIncomingBalance": SignedAmount,
@@ -13149,7 +13145,7 @@ 
Example

   "language": Language,
   "phone": Phone,
   "quizQuestions": [UserQuizQuestion],
-  "totpEnabled": true,
+  "totpEnabled": false,
   "username": Username
 }
 

@@ -13245,7 +13241,7 @@ 
Example

   "alias": ContactAlias,
   "id": Username,
   "transactions": TransactionConnection,
-  "transactionsCount": 987,
+  "transactionsCount": 123,
   "username": Username
 }
 

@@ -13967,7 +13963,7 @@ 
Fields

                   
Example

                   
                     
-                    
{"completed": true, "question": QuizQuestion}
+                    
{"completed": false, "question": QuizQuestion}
 

                     
                   
@@ -14817,7 +14813,7 @@ 
Example

                     
{
   "accountId": "4",
   "balance": SignedAmount,
-  "id": 4,
+  "id": "4",
   "pendingIncomingBalance": SignedAmount,
   "transactions": TransactionConnection,
   "transactionsByAddress": TransactionConnection,