aboutsummaryrefslogtreecommitdiffstats
path: root/apidoc/api_data.js
blob: 63c793faad17498e6df19de2a3101e0539bc74c8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888 } /* Comment */
.highlight .err { color: #A61717; background-color: #E3D2D2 } /* Error */
.highlight .k { color: #080; font-weight: bold } /* Keyword */
.highlight .ch { color: #888 } /* Comment.Hashbang */
.highlight .cm { color: #888 } /* Comment.Multiline */
.highlight .cp { color: #C00; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888 } /* Comment.Single */
.highlight .cs { color: #C00; font-weight: bold; background-color: #FFF0F0 } /* Comment.Special */
.highlight .gd { color: #000; background-color: #FDD } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #A00 } /* Generic.Error */
.highlight .gh { color: #333 } /* Generic.Heading */
.highlight .gi { color: #000; background-color: #DFD } /* Generic.Inserted */
.highlight .go { color: #888 } /* Generic.Output */
.highlight .gp { color: #555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666 } /* Generic.Subheading */
.highlight .gt { color: #A00 } /* Generic.Traceback */
.highlight .kc { color: #080; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #080; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #080; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #080 } /* Keyword.Pseudo */
.highlight .kr { color: #080; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #00D; font-weight: bold } /* Literal.Number */
.highlight .s { color: #D20; background-color: #FFF0F0 } /* Literal.String */
.highlight .na { color: #369 } /* Name.Attribute */
.highlight .nb { color: #038 } /* Name.Builtin */
.highlight .nc { color: #B06; font-weight: bold } /* Name.Class */
.highlight .no { color: #036; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555 } /* Name.Decorator */
.highlight .ne { color: #B06; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #06B; font-weight: bold } /* Name.Function */
.highlight .nl { color: #369; font-style: italic } /* Name.Label */
.highlight .nn { color: #B06; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #369; font-weight: bold } /* Name.Property */
.highlight .nt { color: #B06; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #369 } /* Name.Variable */
.highlight .ow { color: #080 } /* Operator.Word */
.highlight .w { color: #BBB } /* Text.Whitespace */
.highlight .mb { color: #00D; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #00D; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #00D; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #00D; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #00D; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #D20; background-color: #FFF0F0 } /* Literal.String.Affix */
.highlight .sb { color: #D20; background-color: #FFF0F0 } /* Literal.String.Backtick */
.highlight .sc { color: #D20; background-color: #FFF0F0 } /* Literal.String.Char */
.highlight .dl { color: #D20; background-color: #FFF0F0 } /* Literal.String.Delimiter */
.highlight .sd { color: #D20; background-color: #FFF0F0 } /* Literal.String.Doc */
.highlight .s2 { color: #D20; background-color: #FFF0F0 } /* Literal.String.Double */
.highlight .se { color: #04D; background-color: #FFF0F0 } /* Literal.String.Escape */
.highlight .sh { color: #D20; background-color: #FFF0F0 } /* Literal.String.Heredoc */
.highlight .si { color: #33B; background-color: #FFF0F0 } /* Literal.String.Interpol */
.highlight .sx { color: #2B2; background-color: #F0FFF0 } /* Literal.String.Other */
.highlight .sr { color: #080; background-color: #FFF0FF } /* Literal.String.Regex */
.highlight .s1 { color: #D20; background-color: #FFF0F0 } /* Literal.String.Single */
.highlight .ss { color: #A60; background-color: #FFF0F0 } /* Literal.String.Symbol */
.highlight .bp { color: #038 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #06B; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #369 } /* Name.Variable.Class */
.highlight .vg { color: #D70 } /* Name.Variable.Global */
.highlight .vi { color: #33B } /* Name.Variable.Instance */
.highlight .vm { color: #369 } /* Name.Variable.Magic */
.highlight .il { color: #00D; font-weight: bold } /* Literal.Number.Integer.Long */
{
  "passphrase": "கடவுச்சொற்றொடர்",
  "howItWorks": "இது எப்படி வேலை செய்கிறது",
  "installApp": "செயலியை நிறுவு",
  "hiwBasicsTitle": "அடிப்படைகள்",
  "hiwBasics1": "நீங்கள் ஒரு வாலெட்டை உருவாக்கும்போது, பக்கம் பன்னிரண்டு சீரற்ற சொற்களை உருவாக்குகிறது. அந்தச் சொற்களே உங்கள் வாலெட்டின் சாவி. அவற்றை வைத்திருக்கும் எவரும் நாணயங்களைச் செலவழிக்க முடியும், எனவே அவற்றை காகிதத்தில் எழுதி உங்களால் மட்டுமே அணுக முடிந்த இடத்தில் வைத்துக்கொள்ளுங்கள்.",
  "hiwBasics2": "பன்னிரண்டு சொற்களை இழந்து காப்புப்பிரதி இல்லையென்றால், நாணயங்கள் நிரந்தரமாக போய்விடும். மீட்டமைப்பு இணைப்பு எதுவும் இல்லை, அழைக்க யாரும் இல்லை, எனவே பணம் போடுவதற்கு முன் அவற்றை காப்புப்பிரதி எடுங்கள்.",
  "hiwBasics3": "சேவையகம் இல்லை, கணக்கு இல்லை. முழு செயலியும் உங்கள் உலாவியில் இயங்கும் ஒரே ஒரு பக்கம், எனவே உங்கள் நாணயங்களை யாரும் வைத்திருப்பதில்லை, சேவையகத்தில் உள்ள எதுவும் உங்கள் சாவிகளைப் பார்ப்பதில்லை. உங்கள் இருப்பையும் வரலாற்றையும் காட்ட இது ஒரு பொது பிளாக் எக்ஸ்புளோரரிலிருந்து படிக்கிறது (இயல்பாக mempool.space, அல்லது அமைப்புகளில் அமைத்தால் உங்கள் சொந்த நோடு).",
  "hiwBasics4": "இந்தப் பக்கத்தைச் சேமித்து, இணையம் இல்லாமலேயே உங்கள் கணினியிலிருந்து நேரடியாகத் திறக்கலாம். இது ஆஃப்லைனிலும் தொடர்ந்து வேலை செய்கிறது.",
  "hiwBasics5": "இது வழக்கமான பிட்காயின் தரநிலைகளைப் பின்பற்றுகிறது (12-சொல் BIP39 சொற்றொடர் மற்றும் BIP84 நேட்டிவ் SegWit சாவிகள்), எனவே இந்த தளம் எப்போதாவது மறைந்தாலும் அதே சொற்றொடரை Sparrow, Electrum, அல்லது வேறு எந்த தரநிலை வாலெட்டிலும் மீட்டெடுக்கலாம், உங்கள் நாணயங்கள் அங்கேயே இருக்கும்.",
  "hiwTribute": "Hal Wallet என்ற பெயர், புகழ்பெற்ற சைஃபர்பங்க் மற்றும் பிட்காயின் முன்னோடி Hal Finney (1956–2014) அவர்களுக்கான அஞ்சலி.",
  "signExport": "கையொப்பமிட்டு (வேறு இடத்தில் ஒளிபரப்பு)",
  "scanQr": "QR ஐ ஸ்கேன் செய்",
  "scanHint": "கேமராவை ஒரு QR குறியீட்டை நோக்கிக் காட்டுங்கள்",
  "scanNoCamera": "கேமராவை அணுக முடியவில்லை.",
  "scanNoDecoder": "QR ஸ்கேனிங்கிற்கு முதல் முறை பயன்படுத்தும்போது இணைப்பு தேவை.",
  "scanUnrecognized": "அந்த QR இலிருந்து பிட்காயின் முகவரியைப் படிக்க முடியவில்லை.",
  "broadcastScanned": "பரிவர்த்தனையை ஒளிபரப்பவா?",
  "broadcastNow": "ஒளிபரப்பு",
  "scanOffline": "நீங்கள் ஆஃப்லைனில் உள்ளீர்கள் — இந்தப் பரிவர்த்தனையை ஒளிபரப்ப மீண்டும் இணையுங்கள்.",
  "loadingHistory": "பரிவர்த்தனைகள் ஏற்றப்படுகின்றன…",
  "explorer": "பிளாக் எக்ஸ்புளோரர்",
  "explorerDesc": "இருப்புகளுக்கும் வரலாற்றுக்கும் இந்த வாலெட் வினவும் சேவையகம். அதிகபட்ச தனியுரிமைக்கு உங்கள் சொந்த நோடை நோக்கி அமைக்கவும்.",
  "explorerUrl": "சேவையக URL",
  "explorerUrlHint": "Esplora / electrs REST அடிப்படை, எ.கா. https://mempool.space/api",
  "deviceSync": "சாதன ஒத்திசைவு",
  "deviceSyncDesc": "Nostr ரிலேயில் மறையாக்கப்பட்ட நகலைச் சேமிப்பதன் மூலம் உங்கள் சாதனங்களில் இந்த வாலெட்டை ஒத்திசைவாக வைத்திருங்கள் — உங்கள் சீட் உள்ள சாதனம் மட்டுமே அதைப் படிக்க முடியும். எல்லாவற்றையும் இந்தச் சாதனத்தில் மட்டும் வைக்க அதை அணைக்கவும்.",
  "syncAcross": "சாதனங்களில் ஒத்திசை",
  "syncOn": "இயக்கு",
  "syncOff": "அணை",
  "relaysLabel": "ரிலேக்கள்",
  "relaysHint": "ஒரு வரிக்கு ஒரு wss:// URL.",
  "home": "முகப்பு",
  "logout": "வெளியேறு",
  "createNew": "புதிது உருவாக்கு",
  "importExisting": "உள்ளதை இறக்கு",
  "genIntro": "புதிய 12-சொல் சீட் சொற்றொடரை உருவாக்கவும். எழுதி வைக்கவும். இந்த வாலட்டை மீட்க இதுவே ஒரே வழி.",
  "generateSeed": "சீட் சொற்றொடரை உருவாக்கு",
  "writeDownWarn": "⚠ இந்த 12 சொற்களை வரிசையாக காகிதத்தில் எழுதவும். இவை உள்ளவர் உங்கள் நாணயங்களைச் செலவழிக்கலாம்.",
  "copyPhrase": "சொற்றொடரை நகலெடு",
  "regenerate": "மீண்டும் உருவாக்கு",
  "verifyBackup"
define({ "api": [
  {
    "type": "get",
    "url": "/accounts",
    "title": "Retrieve list of accounts",
    "name": "accounts",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of accounts</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"accounts\" : [\n    { \"user\": 'Adam', \"account_id\": '123', balance: 500 ... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/deposits",
    "title": "Retrieve summary of deposits",
    "name": "deposits",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of deposits</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"deposits\" : [\n    { \"seller\": 'Adam', \"buyer\": 'bob' ... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/users",
    "title": "Retrieve user list",
    "name": "getUsers",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Object",
            "optional": false,
            "field": "users",
            "description": "<p>List of users</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"users\" : [\n    { \"username\": 'John Doe', \"email\": '[email protected]', ...},\n    { \"username\": 'Jane Doe', \"email\": '[email protected]', ...}\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/invoices",
    "title": "Retrieve summary of invoices",
    "name": "invoices",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of invoices</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"invoices\" : [\n    { \"seller\": 'Adam', \"buyer\": 'bob' ... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/orders",
    "title": "Retrieve summary of orders",
    "name": "orders",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of orders</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"orders\" : [\n    { \"seller\": 'Adam', \"buyer\": 'bob' ... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/payments",
    "title": "Retrieve summary of payments",
    "name": "payments",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of payments</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"payments\" : [\n    { \"seller\": 'Adam', \"buyer\": 'bob' ... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/referrals",
    "title": "Retrieve list of referral tokens",
    "name": "referrals",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of referral tokens</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"referrals\" : [\n    { \"token\": '***', \"status\": 'pending', sponsor: 'Adam', user: 'newUsername1', expiry: null },\n    { \"token\": '***', \"status\": 'pending', sponsor: 'Adam', user: 'newUsername2', expiry: null },\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/referrals",
    "title": "Retrieve list of referral tokens",
    "name": "referrals",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of referral tokens</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"referrals\" : [\n    { \"token\": '***', \"status\": 'pending', sponsor: 'Adam', user: 'newUsername1', expiry: null },\n    { \"token\": '***', \"status\": 'pending', sponsor: 'Adam', user: 'newUsername2', expiry: null },\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/user_kyc",
    "title": "Retrieve user kyc details",
    "name": "user_kyc",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of kyc details for each user</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"users\" : [\n    { \"username\": 'Adam', \"email\": '[email protected]', ... kyc_data... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/transactions",
    "title": "Retrieve summary of user transactions",
    "name": "user_transactions",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of invoices, payments, orders for users</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"transactions\" : [\n    { \"username\": 'Adam', \"email\": '[email protected]', invoices: 1, orders: 0, payments: 2 },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/withdrawals",
    "title": "Retrieve summary of withdrawals",
    "name": "withdrawals",
    "group": "Admin",
    "permission": [
      {
        "name": "admin"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "returns",
            "description": "<p>list of withdrawals</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"withdrawals\" : [\n    { \"seller\": 'Adam', \"buyer\": 'bob' ... },\n     ...\n   ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/admin.js",
    "groupTitle": "Admin"
  },
  {
    "type": "get",
    "url": "/info",
    "title": "Request server information",
    "name": "GetInfo",
    "group": "Info",
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Object",
            "optional": false,
            "field": "fx",
            "description": "<p>Exchange rates relative to USD - fx.CUR is the value of one CUR in USD.</p>"
          },
          {
            "group": "Success 200",
            "type": "String[]",
            "optional": false,
            "field": "networks",
            "description": "<p>Array of supported networks; possible values are &quot;bitcoin&quot;, &quot;liquid&quot; and &quot;lightning&quot;.</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "clientVersion",
            "description": "<p>the current git commit of the ui</p>"
          }
        ]
      }
    },
    "version": "0.0.0",
    "filename": "routes/info.js",
    "groupTitle": "Info"
  },
  {
    "type": "post",
    "url": "/grant",
    "title": "Grant Referral code",
    "name": "Grant",
    "group": "Referrals",
    "permission": [
      {
        "name": "member"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "sponsor_id",
            "optional": false,
            "field": "user_id",
            "description": "<p>of member generating referral code.</p>"
          },
          {
            "group": "Parameter",
            "type": "expiry",
            "optional": false,
            "field": "optional",
            "description": "<p>expiry date for token.</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "token",
            "description": "<p>referral token</p>"
          },
          {
            "group": "Success 200",
            "type": "Date",
            "optional": false,
            "field": "expiry",
            "description": "<p>optional expiry</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n   \"token\": \"*********\", \n   \"status\": \"available\", \n   \"expiry\": null\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/referrals.js",
    "groupTitle": "Referrals"
  },
  {
    "type": "get",
    "url": "/grant",
    "title": "Grant Referral code (variation using get)",
    "name": "Grant",
    "group": "Referrals",
    "permission": [
      {
        "name": "member"
      },
      {
        "name": "member"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "sponsor_id",
            "optional": false,
            "field": "user_id",
            "description": "<p>of member generating referral code.</p>"
          },
          {
            "group": "Parameter",
            "type": "expiry",
            "optional": false,
            "field": "optional",
            "description": "<p>expiry date for token.</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "token",
            "description": "<p>referral token</p>"
          },
          {
            "group": "Success 200",
            "type": "Status",
            "optional": false,
            "field": "status",
            "description": "<p>referral status</p>"
          },
          {
            "group": "Success 200",
            "type": "Date",
            "optional": false,
            "field": "expiry",
            "description": "<p>optional expiry</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n   \"token\": \"*********\", \n   \"status\": \"available\", \n   \"expiry\": null\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/referrals.js",
    "groupTitle": "Referrals"
  },
  {
    "type": "get",
    "url": "/checkTokens/:sponsor_id",
    "title": "Retrieve list of referral tokens generated by this user",
    "name": "checkTokens",
    "group": "Referrals",
    "permission": [
      {
        "name": "member"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "sponsor_id",
            "optional": false,
            "field": "user_id",
            "description": "<p>of member generating referral code.</p>"
          },
          {
            "group": "Parameter",
            "type": "status",
            "optional": false,
            "field": "optional",
            "description": "<p>token status.</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "tokens",
            "description": "<p>array of token objects</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"tokens\": [\n    {\"token\": \"*********\", \"status\": \"available\", \"expiry\": null}\n  ]\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "routes/referrals.js",
    "groupTitle": "Referrals"
  },
  {
    "type": "get",
    "url": "/isReferred/:user_id",
    "title": "Check if user is referred",
    "name": "isReferred",
    "group": "Referrals",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "user_id",
            "optional": false,
            "field": "user",
            "description": "<p>id</p>"
          }
        ]
      }
    },
    "success": {
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  true\n}",
          "type": "json"
        }
      ]
    },
    "description": "<p>returns boolean indicating if user is referred or not</p>",
    "version": "0.0.0",
    "filename": "routes/referrals.js",
    "groupTitle": "Referrals"
  },
  {
    "type": "post",
    "url": "/joinQueue",
    "title": "Join waiting list (track email & phone)",
    "name": "joinQueue",
    "group": "Referrals",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "email",
            "optional": false,
            "field": "email",
            "description": "<p>address</p>"
          },
          {
            "group": "Parameter",
            "type": "phone",
            "optional": false,
            "field": "phone",
            "description": "<p>number</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "verified",
            "defaultValue": "true",
            "description": ""
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"success\": true\n  \"message\": 'Added to waiting list'\n}",
          "type": "json"
        }
      ]
    },
    "description": "<p>referral token is updated with existing user_id</p>",
    "version": "0.0.0",
    "filename": "routes/referrals.js",
    "groupTitle": "Referrals"
  },
  {
    "type": "get",
    "url": "/verify/:user_id",
    "title": "Verify token and apply to existing user",
    "name": "verify",
    "group": "Referrals",
    "permission": [
      {
        "name": "member"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "user_id",
            "optional": false,
            "field": "Current",
            "description": "<p>user</p>"
          },
          {
            "group": "Parameter",
            "type": "token",
            "optional": false,
            "field": "Token",
            "description": "<p>to validate</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "verified",
            "defaultValue": "true",
            "description": ""
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "HTTP/1.1 200 OK\n{\n  \"verified\": true\n}",
          "type": "json"
        }
      ]
    },
    "description": "<p>referral token is updated with existing user_id</p>",
    "version": "0.0.0",
    "filename": "routes/referrals.js",
    "groupTitle": "Referrals"
  }
] });