diff --git a/static/admin-api-reference.html b/static/admin-api-reference.html index e428e6d..2e57755 100644 --- a/static/admin-api-reference.html +++ b/static/admin-api-reference.html @@ -44,6 +44,7 @@
  • AdminPushNotificationSendInput
  • AdminPushNotificationSendPayload
  • AuditedAccount
  • -
  • AuditedMerchant
  • AuditedUser
  • BTCWallet
  • Boolean
  • -
  • BusinessDeleteMapInfoInput
  • -
  • BusinessUpdateMapInfoInput
  • Coordinates
  • DisplayCurrency
  • Email
  • @@ -109,6 +107,9 @@
  • LnPaymentStatus
  • LnPubkey
  • Memo
  • +
  • Merchant
  • +
  • MerchantMapDeleteInput
  • +
  • MerchantMapValidateInput
  • MerchantPayload
  • NotificationCategory
  • Object
  • @@ -220,6 +221,9 @@
    Query
    createdAt id level + merchants { + ...MerchantFragment + } owner { ...AuditedUserFragment } @@ -238,7 +242,7 @@
    Query
    Variables
    -
    {"accountId": 4}
    +                    
    {"accountId": "4"}
     
    @@ -253,6 +257,7 @@
    Response
    "createdAt": 1592577642, "id": 4, "level": "ONE", + "merchants": [Merchant], "owner": AuditedUser, "status": "ACTIVE", "username": Username, @@ -313,6 +318,9 @@
    Query
    createdAt id level + merchants { + ...MerchantFragment + } owner { ...AuditedUserFragment } @@ -346,6 +354,7 @@
    Response
    "createdAt": 1592577642, "id": 4, "level": "ONE", + "merchants": [Merchant], "owner": AuditedUser, "status": "ACTIVE", "username": Username, @@ -406,6 +415,9 @@
    Query
    createdAt id level + merchants { + ...MerchantFragment + } owner { ...AuditedUserFragment } @@ -439,6 +451,7 @@
    Response
    "createdAt": 1592577642, "id": 4, "level": "ONE", + "merchants": [Merchant], "owner": AuditedUser, "status": "ACTIVE", "username": Username, @@ -499,6 +512,9 @@
    Query
    createdAt id level + merchants { + ...MerchantFragment + } owner { ...AuditedUserFragment } @@ -530,8 +546,9 @@
    Response
    "data": { "accountDetailsByUserPhone": { "createdAt": 1592577642, - "id": 4, + "id": "4", "level": "ONE", + "merchants": [Merchant], "owner": AuditedUser, "status": "ACTIVE", "username": Username, @@ -592,6 +609,9 @@
    Query
    createdAt id level + merchants { + ...MerchantFragment + } owner { ...AuditedUserFragment } @@ -623,8 +643,9 @@
    Response
    "data": { "accountDetailsByUsername": { "createdAt": 1592577642, - "id": "4", + "id": 4, "level": "ONE", + "merchants": [Merchant], "owner": AuditedUser, "status": "ACTIVE", "username": Username, @@ -754,7 +775,7 @@
    Response
    "lightningInvoice": { "confirmedAt": 1592577642, "createdAt": 1592577642, - "description": "abc123", + "description": "xyz789", "expiresAt": 1592577642, "isSettled": true, "received": SatAmount, @@ -923,6 +944,68 @@
    Response
    {"data": {"listWalletIds": [WalletId]}}
    +
    + + + + + + +
    +
    + Queries +
    +

    + merchantsPendingApproval +

    +
    +
    +
    +
    Response
    +

    Returns [Merchant!]! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    + + +
    query merchantsPendingApproval {
    +  merchantsPendingApproval {
    +    coordinates {
    +      ...CoordinatesFragment
    +    }
    +    createdAt
    +    id
    +    title
    +    username
    +    validated
    +  }
    +}
    +
    + + +
    +
    +
    Response
    + + +
    {
    +  "data": {
    +    "merchantsPendingApproval": [
    +      {
    +        "coordinates": Coordinates,
    +        "createdAt": 1592577642,
    +        "id": "4",
    +        "title": "xyz789",
    +        "username": Username,
    +        "validated": true
    +      }
    +    ]
    +  }
    +}
     
    @@ -1019,7 +1102,7 @@
    Query
    Variables
    -
    {"id": 4}
    +                    
    {"id": "4"}
     
    @@ -1033,7 +1116,7 @@
    Response
    "transactionById": { "createdAt": 1592577642, "direction": "RECEIVE", - "id": "4", + "id": 4, "initiationVia": InitiationViaIntraLedger, "memo": Memo, "settlementAmount": SignedAmount, @@ -1159,7 +1242,7 @@
    Response
    { "createdAt": 1592577642, "direction": "RECEIVE", - "id": 4, + "id": "4", "initiationVia": InitiationViaIntraLedger, "memo": Memo, "settlementAmount": SignedAmount, @@ -1276,9 +1359,9 @@
    Response
    {
       "data": {
         "wallet": {
    -      "accountId": 4,
    +      "accountId": "4",
           "balance": SignedAmount,
    -      "id": 4,
    +      "id": "4",
           "invoiceByPaymentHash": Invoice,
           "invoices": InvoiceConnection,
           "pendingIncomingBalance": SignedAmount,
    @@ -1546,18 +1629,18 @@ 
    Response
    -
    +

    - businessDeleteMapInfo + merchantMapDelete

    Response
    -

    Returns an AccountDetailPayload! +

    Returns a MerchantPayload!

    @@ -1572,7 +1655,7 @@
    Arguments
    - input - BusinessDeleteMapInfoInput! + input - MerchantMapDeleteInput! @@ -1587,14 +1670,14 @@

    Example

    Query
    -
    mutation businessDeleteMapInfo($input: BusinessDeleteMapInfoInput!) {
    -  businessDeleteMapInfo(input: $input) {
    -    accountDetails {
    -      ...AuditedAccountFragment
    -    }
    +                    
    mutation merchantMapDelete($input: MerchantMapDeleteInput!) {
    +  merchantMapDelete(input: $input) {
         errors {
           ...ErrorFragment
         }
    +    merchant {
    +      ...MerchantFragment
    +    }
       }
     }
     
    @@ -1605,7 +1688,7 @@
    Query
    Variables
    -
    {"input": BusinessDeleteMapInfoInput}
    +                    
    {"input": MerchantMapDeleteInput}
     
    @@ -1616,9 +1699,9 @@
    Response
    {
       "data": {
    -    "businessDeleteMapInfo": {
    -      "accountDetails": AuditedAccount,
    -      "errors": [Error]
    +    "merchantMapDelete": {
    +      "errors": [Error],
    +      "merchant": Merchant
         }
       }
     }
    @@ -1629,12 +1712,12 @@ 
    Response
    -
    +

    - businessUpdateMapInfo + merchantMapValidate

    @@ -1655,7 +1738,7 @@
    Arguments
    - input - BusinessUpdateMapInfoInput! + input - MerchantMapValidateInput! @@ -1670,13 +1753,13 @@

    Example

    Query
    -
    mutation businessUpdateMapInfo($input: BusinessUpdateMapInfoInput!) {
    -  businessUpdateMapInfo(input: $input) {
    +                    
    mutation merchantMapValidate($input: MerchantMapValidateInput!) {
    +  merchantMapValidate(input: $input) {
         errors {
           ...ErrorFragment
         }
         merchant {
    -      ...AuditedMerchantFragment
    +      ...MerchantFragment
         }
       }
     }
    @@ -1688,7 +1771,7 @@ 
    Query
    Variables
    -
    {"input": BusinessUpdateMapInfoInput}
    +                    
    {"input": MerchantMapValidateInput}
     
    @@ -1699,9 +1782,9 @@
    Response
    {
       "data": {
    -    "businessUpdateMapInfo": {
    +    "merchantMapValidate": {
           "errors": [Error],
    -      "merchant": AuditedMerchant
    +      "merchant": Merchant
         }
       }
     }
    @@ -2088,7 +2171,7 @@ 
    Example
    {
       "accountId": AccountId,
    -  "comment": "abc123",
    +  "comment": "xyz789",
       "status": "ACTIVE"
     }
     
    @@ -2161,7 +2244,7 @@
    Example
    {
       "accountId": "abc123",
    -  "body": "xyz789",
    +  "body": "abc123",
       "data": Object,
       "notificationCategory": NotificationCategory,
       "title": "xyz789"
    @@ -2258,6 +2341,12 @@ 
    Fields
    + + merchants - [Merchant!]! + + + + owner - AuditedUser! @@ -2293,87 +2382,14 @@
    Example
    {
       "createdAt": 1592577642,
    -  "id": "4",
    +  "id": 4,
       "level": "ONE",
    +  "merchants": [Merchant],
       "owner": AuditedUser,
       "status": "ACTIVE",
       "username": Username,
       "wallets": [Wallet]
     }
    -
    - - -
    -
    - -
    -
    -
    - Types -
    -

    AuditedMerchant

    -
    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Field NameDescription
    coordinates - Coordinates - GPS coordinates for the merchant that can be used to place the related business on a map
    createdAt - Timestamp! - -
    id - ID! - -
    title - String! - -
    username - Username! - The username of the merchant
    validated - Boolean! - Whether the merchant has been validated
    -
    -
    -
    -
    -
    Example
    - - -
    {
    -  "coordinates": Coordinates,
    -  "createdAt": 1592577642,
    -  "id": "4",
    -  "title": "abc123",
    -  "username": Username,
    -  "validated": false
    -}
     
    @@ -2702,7 +2718,7 @@
    Example
    {
       "accountId": 4,
       "balance": SignedAmount,
    -  "id": 4,
    +  "id": "4",
       "invoiceByPaymentHash": Invoice,
       "invoices": InvoiceConnection,
       "pendingIncomingBalance": SignedAmount,
    @@ -2737,114 +2753,6 @@ 
    Description
    -
    -
    - Types -
    -

    BusinessDeleteMapInfoInput

    -
    -
    -
    -
    Fields
    - - - - - - - - - - - - - -
    Input FieldDescription
    - username - Username! - -
    -
    -
    -
    -
    -
    Example
    - - -
    {"username": Username}
    -
    - - -
    -
    -
    -
    -
    -
    - Types -
    -

    BusinessUpdateMapInfoInput

    -
    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Input FieldDescription
    - latitude - Float! - -
    - longitude - Float! - -
    - title - String! - -
    - username - Username! - -
    -
    -
    -
    -
    -
    Example
    - - -
    {
    -  "latitude": 987.65,
    -  "longitude": 987.65,
    -  "title": "xyz789",
    -  "username": Username
    -}
    -
    - - -
    -
    -
    -
    Types @@ -2883,7 +2791,7 @@
    Fields
    Example
    -
    {"latitude": 123.45, "longitude": 123.45}
    +                    
    {"latitude": 987.65, "longitude": 123.45}
     
    @@ -3053,7 +2961,7 @@
    Example
    {
       "code": "xyz789",
    -  "message": "xyz789",
    +  "message": "abc123",
       "path": ["abc123"]
     }
     
    @@ -3080,7 +2988,7 @@
    Description
    Example
    -
    987.65
    +                    
    123.45
     
    @@ -3133,9 +3041,9 @@
    Example
    {
    -  "code": "abc123",
    -  "message": "xyz789",
    -  "path": ["xyz789"]
    +  "code": "xyz789",
    +  "message": "abc123",
    +  "path": ["abc123"]
     }
     
    @@ -3541,7 +3449,7 @@
    Example
    {
    -  "cursor": "abc123",
    +  "cursor": "xyz789",
       "node": Invoice
     }
     
    @@ -3704,9 +3612,9 @@
    Example
    {
       "confirmedAt": 1592577642,
       "createdAt": 1592577642,
    -  "description": "abc123",
    +  "description": "xyz789",
       "expiresAt": 1592577642,
    -  "isSettled": true,
    +  "isSettled": false,
       "received": SatAmount,
       "request": LnPaymentRequest,
       "secretPreImage": LnPaymentPreImage
    @@ -3970,6 +3878,162 @@ 
    Example
    Memo
    +
    + + +
    + + +
    +
    +
    + Types +
    +

    Merchant

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    coordinates - Coordinates! + GPS coordinates for the merchant that can be used to place the related business on a map
    createdAt - Timestamp! + +
    id - ID! + +
    title - String! + +
    username - Username! + The username of the merchant
    validated - Boolean! + Whether the merchant has been validated
    +
    +
    +
    +
    +
    Example
    + + +
    {
    +  "coordinates": Coordinates,
    +  "createdAt": 1592577642,
    +  "id": 4,
    +  "title": "xyz789",
    +  "username": Username,
    +  "validated": true
    +}
    +
    + + +
    +
    +
    +
    +
    +
    + Types +
    +

    MerchantMapDeleteInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + id - ID! + +
    +
    +
    +
    +
    +
    Example
    + + +
    {"id": "4"}
    +
    + + +
    +
    +
    +
    +
    +
    + Types +
    +

    MerchantMapValidateInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + id - ID! + +
    +
    +
    +
    +
    +
    Example
    + + +
    {"id": "4"}
     
    @@ -4001,7 +4065,7 @@
    Fields
    - merchant - AuditedMerchant + merchant - Merchant @@ -4017,7 +4081,7 @@
    Example
    {
       "errors": [Error],
    -  "merchant": AuditedMerchant
    +  "merchant": Merchant
     }
     
    @@ -4167,8 +4231,8 @@
    Example
    {
       "endCursor": "xyz789",
       "hasNextPage": false,
    -  "hasPreviousPage": false,
    -  "startCursor": "abc123"
    +  "hasPreviousPage": true,
    +  "startCursor": "xyz789"
     }
     
    @@ -4287,8 +4351,8 @@
    Example
    {
       "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "offset": 987
    +  "currencyUnit": "abc123",
    +  "offset": 123
     }
     
    @@ -4355,9 +4419,9 @@
    Example
    {
       "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "formattedAmount": "abc123",
    -  "offset": 987
    +  "currencyUnit": "abc123",
    +  "formattedAmount": "xyz789",
    +  "offset": 123
     }
     
    @@ -4837,7 +4901,7 @@
    Example
    {
       "createdAt": 1592577642,
       "direction": "RECEIVE",
    -  "id": "4",
    +  "id": 4,
       "initiationVia": InitiationViaIntraLedger,
       "memo": Memo,
       "settlementAmount": SignedAmount,
    @@ -4949,7 +5013,7 @@ 
    Example
    {
    -  "cursor": "xyz789",
    +  "cursor": "abc123",
       "node": Transaction
     }
     
    @@ -5316,7 +5380,7 @@
    Example
    {
       "accountId": "4",
       "balance": SignedAmount,
    -  "id": "4",
    +  "id": 4,
       "invoiceByPaymentHash": Invoice,
       "invoices": InvoiceConnection,
       "pendingIncomingBalance": SignedAmount,
    @@ -5684,9 +5748,9 @@ 
    Example
    {
    -  "accountId": 4,
    +  "accountId": "4",
       "balance": SignedAmount,
    -  "id": 4,
    +  "id": "4",
       "invoiceByPaymentHash": Invoice,
       "invoices": InvoiceConnection,
       "pendingIncomingBalance": SignedAmount,