project and link it as the settlement wallet"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 16b:["Get all projects"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 16c:["Get a single project"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 16d:["Get the project settlement wallet (default / dedicated / account / nwc / provider)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 16e:["Get project statistics"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 16f:["Invite a member by email (owner only)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 170:["List project members (viewer+)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 171:["My pending invitations (accept/decline here)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 172:["Projects shared with me (I am a member)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 173:["Delete a project"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 174:["Revoke membership or decline an invitation"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 175:["Link the settlement wallet: 'default' | 'account:' | 'nwc:' | 'provider:' (legacy)"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 176:["Update a project"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 177:["Change a member role (owner only)"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 178:["Create a new provider connection"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 179:["Disconnect provider"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 17a:["Get all providers"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 17b:["Get a single provider"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 17c:["Delete a provider"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 17d:["Test provider connection"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 17e:["Public SSE stream for one invoice (paymentHash capability)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 17f:["SSE stream of the authenticated user’s realtime events"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 180:["Create a refund for a paid invoice"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 181:["List all refunds (merchant)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 182:["List refunds for an invoice"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 183:["Relay allowlist check — is this pubkey a current member? (called by relay auth plugins)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 184:["Buyer checks if their payment settled"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 185:["Create a relay access pass"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 186:["Issue an invoice for a buyer pubkey (public)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 187:["List my relay passes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 188:["Relay pass detail"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 189:["Public pass view (title, price, relay)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 18a:["Recent buyer grants for this pass"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 18b:["Delete a relay pass"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 18c:["Enable/disable a relay pass"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 18d:["Delete the scrub rule"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 18e:["Get my scrub rule (null when none)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 18f:["Forward history (audit trail)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 190:["Create or replace the scrub rule"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 191:["Global dashboard search"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 192:["Delete the split rule for a project"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 193:["Get the split rule for a project"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 194:["Split payout history for a project"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 195:["Create or replace the split rule for a project"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 196:["Cancel via magic link"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 197:["Disable NWC auto-pay"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 198:["Enable NWC auto-pay (subscriber wallet connection)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 199:["Subscriber portal (magic link)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 19a:["Public plan detail (checkout page)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 19b:["Pause renewals via magic link"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 19c:["Resume via magic link"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 19d:["Subscribe to a plan (public checkout)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 19e:["Cancel a subscription (owner action)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 19f:["List subscribers of a project"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1a0:["Project MRR/ARR in sats"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1a1:["Reverse swap — deposit on-chain BTC into your wallet"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1a2:["Submarine swap — withdraw sats to a Bitcoin address"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1a3:["List my swaps"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1a4:["Swap detail"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1a5:["Swap availability, limits and fees"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1a6:["Poll the Boltz status and update the swap"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1a7:["Add a charge or credit to the tab"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1a8:["Archive a tab"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 1a9:["Cancel a pending settlement"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1aa:["Settlement confirmation check (public)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1ab:["Open a tab"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1ac:["Pay (part of) the tab balance (public)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1ad:["List my tabs"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1ae:["Tab detail (owner)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1af:["Public tab view — balance + recent entries"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1b0:["Tab entries (owner)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1b1:["Tab settlements (owner)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1b2:["Close or reopen a tab"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 1b3:["Delete a blob by URL"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1b4:["Blob credential status (diagnostic — no secrets exposed)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1b5:["Mint client-upload token (used by @vercel/blob/client)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1b6:["Upload an image through the server (≤5 MB)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1b7:["Get current quota usage"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1b8:["Get usage statistics"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1b9:["Bulk activate users"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1ba:["Bulk deactivate users"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1bb:["Bulk delete users"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1bc:["Create a new user (Admin only)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1bd:["Get all users with pagination (Admin/Moderator)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1be:["Get a user by ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1bf:["Get user statistics (Admin/Moderator)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1c0:["Delete a user"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1c1:["Advanced search for users"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1c2:["Update a user"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 1c3:["Check payment status"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1c4:["Convert fiat to sats or vice versa"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1c5:["Create a new account (user + wallet) for other users"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1c6:["Create invoice (receive sats)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1c7:["Create a new wallet"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1c8:["Decode a BOLT11 invoice"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1c9:["Generate QR code for arbitrary data"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1ca:["List available currencies"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1cb:["Get exchange rate for a currency"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1cc:["Get wallet payments"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1cd:["Get payments history for charts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1ce:["Get wallet info and balance"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1cf:["List all wallets of the user"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1d0:["Scan/decode an LNURL or lightning address"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d1:["Pay a BOLT11 invoice (send sats)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d2:["Pay an LNURL or lightning address"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d3:["Build a PSBT spending to a destination (p2wpkh wallets)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d4:["List my watch-only wallets"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1d5:["Wallet detail"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1d6:["Fresh receive address (reuses the newest unused one, else derives next)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d7:["Import an xpub (watch-only wallet)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1d8:["List derived addresses (with balances)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1d9:["Refresh balances from mempool.space"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1da:["Delete a watch-only wallet"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1db:["Create a new webhook endpoint"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1dc:["Delivery status counts for dashboard stat cards"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1dd:["Export webhook deliveries as CSV"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1de:["Get all webhooks"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1df:["List webhook deliveries (retry dashboard)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1e0:["Get a single delivery (full payload + error)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1e1:["Get a single webhook"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1e2:["Delete a webhook"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1e3:["Replay an event to all subscribed endpoints"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1e4:["Manually retry a delivery"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1e5:["Reveal the webhook signing secret"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1e6:["Roll (rotate) the webhook signing secret"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1e7:["Test webhook delivery"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1e8:["Update webhook status"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 1e9:["Withdraw sats (BOLT11 / lightning address / LNURL)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1ea:["Withdrawal history"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1eb:["Withdrawal detail (incl. preimage proof)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1ec:["Current velocity-limit usage"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1ed:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"rocket","size":24,"node":[["path",{"d":"M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5","key":"qeys4"}],["path",{"d":"M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09","key":"u4xsad"}],["path",{"d":"M9 12a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.4 22.4 0 0 1-4 2z","key":"676m9"}],["path",{"d":"M9 12H4s.55-3.03 2-4c1.62-1.08 5 .05 5 .05","key":"92ym6u"}]]},"className":"size-4"}] 1ef:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"book-open","size":24,"node":[["path",{"d":"M12 5v16","key":"1f6ucr"}],["path",{"d":"M20.001 19A2 2 0 0022 17V5a2 2 0 00-1.999-2L16 3.002A5 5 0 0012 5a5 5 0 00-4-2H4a2 2 0 00-2 2v12a2 2 0 001.999 2H8a5 5 0 014 2 5 5 0 014-2z","key":"1fyvmf"}]]},"className":"size-4"}] 1f1:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"brain-circuit","size":24,"node":[["path",{"d":"M12 13h4","key":"1ku699"}],["path",{"d":"M12 18h6a2 2 0 012 2v1","key":"6s3bw4"}],["path",{"d":"M12 8h8","key":"1lhi5i"}],["path",{"d":"M12 9a4.17 4.17 0 01-3 4","key":"13l7kh"}],["path",{"d":"M16 8V5a2 2 0 012-2","key":"gais5y"}],["path",{"d":"M6 18a4 4 0 01-2-7.465","key":"1y2m15"}],["path",{"d":"M6.004 5.125a4 4 0 00-2.526 5.77","key":"3cw1ss"}],["path",{"d":"M6.294 6.294A3 3 0 1112 5v13a4 4 0 11-7.967-.518","key":"m2z1wm"}],["circle",{"cx":"16","cy":"13","r":"0.5","fill":"currentColor","key":"9zzywh"}],["circle",{"cx":"18","cy":"3","r":"0.5","fill":"currentColor","key":"i2xui6"}],["circle",{"cx":"20","cy":"21","r":"0.5","fill":"currentColor","key":"1dobdp"}],["circle",{"cx":"20","cy":"8","r":"0.5","fill":"currentColor","key":"r9nqlq"}]]},"className":"size-4"}] 1f3:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"layers","size":24,"node":[["path",{"d":"M12.83 2.18a2 2 0 0 0-1.66 0L2.6 6.08a1 1 0 0 0 0 1.83l8.58 3.91a2 2 0 0 0 1.66 0l8.58-3.9a1 1 0 0 0 0-1.83z","key":"zw3jo"}],["path",{"d":"M2 12a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 12","key":"1wduqc"}],["path",{"d":"M2 17a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 17","key":"kqbvx6"}]],"aliases":["layers-3"]},"className":"size-4"}] 1f5:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"zap","size":24,"node":[["path",{"d":"M15.914 4a1.5 1.5 0 00-2.474-1.561l-9 9A1.5 1.5 0 005.5 14h4.002a.5.5 0 01.471.666L8.086 20a1.5 1.5 0 002.475 1.56l9-9A1.5 1.5 0 0018.5 10h-3.997a.5.5 0 01-.472-.667z","key":"1v7up4"}]]},"className":"size-4"}] 1f7:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"code-xml","size":24,"node":[["path",{"d":"m18 16 4-4-4-4","key":"1inbqp"}],["path",{"d":"m6 8-4 4 4 4","key":"15zrgr"}],["path",{"d":"m14.5 4-5 16","key":"e7oirm"}]],"aliases":["code-2"]},"className":"size-4"}] 1f9:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"key-round","size":24,"node":[["path",{"d":"M2.586 17.414A2 2 0 0 0 2 18.828V21a1 1 0 0 0 1 1h3a1 1 0 0 0 1-1v-1a1 1 0 0 1 1-1h1a1 1 0 0 0 1-1v-1a1 1 0 0 1 1-1h.172a2 2 0 0 0 1.414-.586l.814-.814a6.5 6.5 0 1 0-4-4z","key":"1s6t7t"}],["circle",{"cx":"16.5","cy":"7.5","r":".5","fill":"currentColor","key":"w0ekpg"}]]},"className":"size-4"}] 1fb:["$","$L20f",null,{"ref":"$undefined","icon":{"name":"sparkles","size":24,"node":[["path",{"d":"M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594z","key":"1s2grr"}],["path",{"d":"M20 2v4","key":"1rf3ol"}],["path",{"d":"M22 4h-4","key":"gwowj6"}],["circle",{"cx":"4","cy":"20","r":"2","key":"6kqj1y"}]],"aliases":["stars"]},"className":"size-4"}] 1fd:["$","span",null,{"className":"flex items-center gap-2 font-semibold","children":[["$","$L20f",null,{"ref":"$undefined","icon":"$1f5:props:icon","className":"size-5 text-yellow-500","aria-hidden":true}],"ZapAPI Docs"]}] 1fe:["$","$L6",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","forbidden":"$undefined","unauthorized":"$undefined"}] 200:["$","$1","c",{"children":[null,["$","$L6",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","forbidden":"$undefined","unauthorized":"$undefined"}]]}] 203:["$","$1","c",{"children":["$L210",[["$","script","script-0",{"src":"/_next/static/immutable/chunks/3dnlfx6egoo9r.js","async":true,"nonce":"$undefined"}],["$","script","script-1",{"src":"/_next/static/immutable/chunks/1bd2qu74cohtf.js","async":true,"nonce":"$undefined"}],["$","script","script-2",{"src":"/_next/static/immutable/chunks/0uy5_0brdgyrh.js","async":true,"nonce":"$undefined"}]],["$","$L211",null,{"children":["$","$209",null,{"name":"Next.MetadataOutlet","children":"$@212"}]}]]}] 201:C 217:T8df, # ZapAPI — Lightning Payments API ## Overview Non-custodial Lightning payment infrastructure: invoices, payment links, Lightning addresses, subscriptions, zaps and webhooks — settled directly to your own LNbits/node, never held by ZapAPI. ## Features - ⚡ Lightning invoices (BOLT-11) with hosted checkout - 🔗 Payment links, Lightning addresses (LUD-06/16) & Nostr zaps - 👥 Creator subscriptions with recurring LNURL billing - 🔑 Scoped API keys (`zap_live_`/`zap_test_`) for server integrations - 📡 Signed webhooks with automatic retries, manual retry & event replay - 🛡️ JWT dashboard auth (access + refresh) alongside API keys - 🔄 API Versioning (URI & Header-based) ## Authentication Two auth schemes, both via the `Authorization` header: ### API keys (server-to-server) ``` Authorization: Bearer zap_live_your_key_here ``` Keys are scoped (e.g. `invoices:write`, `webhooks:read`) and prefixed `zap_live_` (production) or `zap_test_` (test mode). ### JWT (dashboard sessions) ``` Authorization: Bearer ``` - **Access Token**: 15 minutes expiry - **Refresh Token**: 7 days expiry - **Refresh Endpoint**: `POST /api/v1/auth/refresh` ## Response Envelope Every JSON response is wrapped: ```json { "status": "success", "statusCode": 200, "message": "Request successful", "data": {}, "timestamp": "2026-10-24T00:00:00.000Z", "path": "/api/v1/invoices" } ``` ## Error Handling Errors use the same envelope with `status: "error"`: ```json { "status": "error", "statusCode": 400, "message": "Error description", "errors": ["Detailed validation errors"], "timestamp": "2026-10-24T00:00:00.000Z", "path": "/api/v1/endpoint" } ``` ## API Versioning ### URI Versioning (Recommended) ``` GET /api/v1/users ``` ### Header Versioning ``` X-API-Version: 1 Accept-Version: 1 ``` ## Webhooks Outbound events are POSTed to your endpoints with Stripe-style signatures: `X-ZapAPI-Signature: t=,v1=`. Failed deliveries retry 5 times with exponential backoff; delivery history, manual retries and event replay are available via the `/api/v1/webhooks/deliveries` endpoints and the dashboard. ## Support - **Documentation**: [docs.zapapi.com](https://docs.zapapi.com) 210:["$","$L213",null,{"toc":[],"full":true,"children":[["$","script",null,{"type":"application/ld+json","dangerouslySetInnerHTML":{"__html":"{\"@context\":\"https://schema.org\",\"@type\":\"TechArticle\",\"headline\":\"Enable/disable a relay pass\",\"url\":\"https://docs.zapapi.app/docs/api/relay-passes/updateStatus\",\"image\":\"https://docs.zapapi.app/og/docs/api/relay-passes/updateStatus/image.png\",\"author\":{\"@type\":\"Organization\",\"name\":\"ZapAPI Docs\"},\"publisher\":{\"@type\":\"Organization\",\"name\":\"ZapAPI Docs\"},\"isPartOf\":{\"@type\":\"WebSite\",\"name\":\"ZapAPI Docs\",\"url\":\"https://docs.zapapi.app\"}}"}}],["$","$L214",null,{"children":"Enable/disable a relay pass"}],["$","$L215",null,{"children":["$","$L216",null,{"payload":{"bundled":{"openapi":"3.2.0","paths":{"/":{"get":{"operationId":"getHello","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"API is running"}},"summary":"Health check endpoint","tags":["health"]}},"/favicon.ico":{"get":{"operationId":"getFavicon","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"204":{"description":"No favicon available"}},"summary":"Favicon endpoint","tags":["health"]}},"/api/v1/admin/request-logs":{"get":{"operationId":"getRequestLogs","parameters":[{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all request logs","tags":["Request Logs"]}},"/api/v1/admin/request-logs/user":{"get":{"operationId":"getUserRequestLogs","parameters":[{"name":"userId","required":true,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs/user"}]}}}}},"security":[{"bearer":[]}],"summary":"Get request logs for specific user","tags":["Request Logs"]}},"/api/v1/admin/request-logs/statistics":{"get":{"operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get request log statistics","tags":["Request Logs"]}},"/api/v1/admin/request-logs/cleanup/stats":{"get":{"operationId":"getCleanupStats","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs/cleanup/stats"}]}}}}},"security":[{"bearer":[]}],"summary":"Get cleanup statistics","tags":["Request Logs"]}},"/api/v1/admin/request-logs/cleanup/trigger":{"post":{"operationId":"triggerCleanup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCleanupDto"}}}},"responses":{"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs/cleanup/trigger"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs/cleanup/trigger"}]}}}},"500":{"description":"Internal Server Error - Unexpected error occurred.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":500,"message":"Internal server error","timestamp":"2026-01-31T19:20:00.000Z","path":"/admin/request-logs/cleanup/trigger"}]}}}}},"security":[{"bearer":[]}],"summary":"Manually trigger log cleanup","tags":["Request Logs"]}},"/api/v1/realtime/stream":{"get":{"operationId":"streamUser","parameters":[{"name":"token","required":false,"in":"query","description":"JWT (EventSource)","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"SSE stream of the authenticated user’s realtime events","tags":["realtime"]}},"/api/v1/realtime/stream/invoice/{paymentHash}":{"get":{"operationId":"streamInvoice","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Public SSE stream for one invoice (paymentHash capability)","tags":["realtime"]}},"/api/v1/search":{"get":{"description":"Fans out across invoices, payments, payment links, bio pages, customers, webhooks and lightning addresses in parallel. Always scoped to the caller.","operationId":"search","parameters":[{"name":"q","required":true,"in":"query","description":"Search query (min 2 chars)","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Global dashboard search","tags":["search"]}},"/api/v1/cron/reconcile-payments":{"get":{"operationId":"reconcile","parameters":[{"name":"authorization","required":true,"in":"header","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Sweep stale pending invoices and settle paid ones (Vercel Cron)","tags":["cron"]}},"/api/v1/cron/run":{"get":{"operationId":"run","parameters":[{"name":"authorization","required":true,"in":"header","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Run all due scheduled sweeps (Vercel Cron — every minute)","tags":["cron"]}},"/api/v1/auth/register":{"post":{"description":"Creates a new user account and sends email verification link. Rate limited to 5 requests per minute.","operationId":"register","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDto"}}}},"responses":{"201":{"description":"User registered successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":201,"message":"Registration successful. Please check your email to verify your account.","data":{"user":{"id":"123e4567-e89b-12d3-a456-426614174000","email":"john.doe@example.com","firstName":"John","lastName":"Doe","isActive":true,"isEmailVerified":false,"createdAt":"2026-01-31T10:00:00.000Z","updatedAt":"2026-01-31T10:00:00.000Z"},"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","refreshToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"meta":{"user_id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2026-01-31T10:00:00.000Z","email_verification_required":true},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/register"}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/register"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"User with this email already exists","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/register"}]}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":429,"message":"ThrottlerException: Too Many Requests","timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/register"}]}}}}},"summary":"Register a new user","tags":["auth"]}},"/api/v1/auth/login":{"post":{"description":"Authenticate user with email and password. Rate limited to 10 requests per minute.","operationId":"login","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginDto"}}}},"responses":{"200":{"description":"Login successful","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Login successful","data":{"user":{"id":"123e4567-e89b-12d3-a456-426614174000","email":"john.doe@example.com","firstName":"John","lastName":"Doe","isActive":true,"isEmailVerified":true,"createdAt":"2026-01-31T10:00:00.000Z","updatedAt":"2026-01-31T10:00:00.000Z"},"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","refreshToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"meta":{"user_id":"123e4567-e89b-12d3-a456-426614174000","is_email_verified":true},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/login"}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/login"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/login"}]}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":429,"message":"ThrottlerException: Too Many Requests","timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/login"}]}}}}},"summary":"Login user","tags":["auth"]}},"/api/v1/auth/nostr/challenge":{"get":{"description":"Issues a single-use challenge for a pubkey (npub or hex). Sign a kind 27235 event with tags [\"challenge\", c] and [\"expires\", unix] and POST it to /auth/nostr.","operationId":"nostrChallenge","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Get a nostr login challenge","tags":["auth"]}},"/api/v1/auth/nostr":{"post":{"description":"Verify a signed kind 27235 login event. Resolves the account from linked identities/wallet/addresses, or auto-provisions a new nostr-first user.","operationId":"nostrLogin","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Login with nostr (passwordless)","tags":["auth"]}},"/api/v1/auth/nostr/nsec":{"post":{"description":"For users without a browser signer. The key signs a login event server-side and is never stored or logged. Auto-provisions new keys.","operationId":"nostrNsecLogin","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Login with an nsec (private key)","tags":["auth"]}},"/api/v1/auth/logout":{"post":{"description":"Blacklists the current access token and revokes all refresh tokens","operationId":"logout","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Logout successful","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Logout successful","data":null,"meta":{"user_id":"123e4567-e89b-12d3-a456-426614174000","logged_out_at":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/logout"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/logout"}]}}}}},"security":[{"bearer":[]}],"summary":"Logout user","tags":["auth"]}},"/api/v1/auth/refresh":{"post":{"description":"Get a new access token using a valid refresh token. Rate limited to 20 requests per minute.","operationId":"refreshToken","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenDto"}}}},"responses":{"200":{"description":"Token refreshed successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Token refreshed successfully","data":{"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","refreshToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"meta":{"user_id":"123e4567-e89b-12d3-a456-426614174000","refreshed_at":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/refresh"}]}}}},"401":{"description":"Invalid or expired refresh token"}},"summary":"Refresh access token","tags":["auth"]}},"/api/v1/auth/forgot-password":{"post":{"description":"Sends password reset link to user email. Rate limited to 3 requests per hour.","operationId":"forgotPassword","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgotPasswordDto"}}}},"responses":{"200":{"description":"Password reset email sent","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"If an account with that email exists, a password reset link has been sent.","data":null,"meta":{"email_sent_at":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/forgot-password"}]}}}}},"summary":"Request password reset","tags":["auth"]}},"/api/v1/auth/reset-password":{"post":{"description":"Reset password using token from email. Rate limited to 5 requests per hour.","operationId":"resetPassword","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordDto"}}}},"responses":{"200":{"description":"Password reset successful","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Password reset successful. Please login with your new password.","data":null,"meta":{"user_id":"123e4567-e89b-12d3-a456-426614174000","password_reset_at":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/reset-password"}]}}}},"400":{"description":"Invalid or expired reset token"}},"summary":"Reset password","tags":["auth"]}},"/api/v1/auth/verify-email":{"post":{"description":"Verify user email using token from email. Rate limited to 5 requests per hour.","operationId":"verifyEmail","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyEmailDto"}}}},"responses":{"200":{"description":"Email verified successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Email verified successfully","data":null,"meta":{"user_id":"123e4567-e89b-12d3-a456-426614174000","verified_at":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/verify-email"}]}}}},"400":{"description":"Invalid or expired verification token"}},"summary":"Verify email","tags":["auth"]}},"/api/v1/auth/resend-verification":{"post":{"description":"Sends a new email verification link. Rate limited to 3 requests per hour.","operationId":"resendVerification","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Verification email sent","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Verification email sent successfully","data":null,"meta":{"email_sent_at":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/resend-verification"}]}}}}},"security":[{"bearer":[]}],"summary":"Resend email verification","tags":["auth"]}},"/api/v1/auth/me":{"get":{"description":"Returns the authenticated user profile","operationId":"getCurrentUser","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"User profile retrieved","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"User profile retrieved successfully","data":{"id":"123e4567-e89b-12d3-a456-426614174000","email":"john.doe@example.com"},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/me"}]}}}}},"security":[{"bearer":[]}],"summary":"Get current user","tags":["auth"]}},"/api/v1/auth/sessions":{"get":{"operationId":"getSessions","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"List of active sessions retrieved successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Sessions retrieved successfully","data":[{"id":"123e4567-e89b-12d3-a456-426614174000","deviceName":"Chrome on macOS","deviceType":"desktop","ipAddress":"192.168.1.1","lastActivityAt":"2026-01-31T10:00:00.000Z","createdAt":"2026-01-31T09:00:00.000Z","expiresAt":"2026-02-07T09:00:00.000Z","isCurrent":true}],"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/sessions"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/sessions"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all active sessions","tags":["auth"]}},"/api/v1/auth/sessions/revoke":{"delete":{"operationId":"revokeSession","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeSessionDto"}}}},"responses":{"200":{"description":"Session revoked successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Session revoked successfully","timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/sessions/revoke"}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/sessions/revoke"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/sessions/revoke"}]}}}}},"security":[{"bearer":[]}],"summary":"Revoke a specific session","tags":["auth"]}},"/api/v1/auth/sessions/revoke-others":{"delete":{"operationId":"revokeOtherSessions","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeOtherSessionsDto"}}}},"responses":{"200":{"description":"Other sessions revoked successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"All other sessions revoked successfully","data":{"revoked_count":3},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/sessions/revoke-others"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/sessions/revoke-others"}]}}}}},"security":[{"bearer":[]}],"summary":"Revoke all other sessions","tags":["auth"]}},"/api/v1/auth/sessions/logout-all":{"delete":{"operationId":"logoutAllDevices","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Logged out from all devices successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Logged out from all devices successfully","data":{"revoked_count":5},"timestamp":"2026-01-31T10:00:00.000Z","path":"/api/v1/auth/sessions/logout-all"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/auth/sessions/logout-all"}]}}}}},"security":[{"bearer":[]}],"summary":"Logout from all devices","tags":["auth"]}},"/api/v1/auth/2fa/status":{"get":{"operationId":"status","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"2FA status + backup codes remaining","tags":["auth"]}},"/api/v1/auth/2fa/setup":{"post":{"description":"Generates a pending TOTP secret. 2FA is NOT active until `enable` verifies the first code. Fails if 2FA is already enabled (disable first).","operationId":"setup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Setup material"}},"security":[{"bearer":[]}],"summary":"Start 2FA setup — returns secret + QR code","tags":["auth"]}},"/api/v1/auth/2fa/enable":{"post":{"description":"Verifies the first TOTP code and activates 2FA. Returns 10 single-use backup codes — shown ONCE, store them securely.","operationId":"enable","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"400":{"description":"Invalid code"}},"security":[{"bearer":[]}],"summary":"Activate 2FA — verify first code, get backup codes","tags":["auth"]}},"/api/v1/auth/2fa":{"delete":{"operationId":"disable","parameters":[{"name":"code","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Disable 2FA — requires a TOTP or backup code","tags":["auth"]}},"/api/v1/auth/2fa/backup-codes":{"post":{"description":"Invalidates the previous set. New codes shown once.","operationId":"regenerateBackupCodes","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Regenerate backup codes — requires a valid TOTP code","tags":["auth"]}},"/api/v1/auth/2fa/verify":{"post":{"operationId":"verify","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"401":{"description":"Invalid code or expired challenge"}},"summary":"Complete 2FA login — exchange the challenge token for tokens","tags":["auth"]}},"/api/v1/my-wallet":{"get":{"operationId":"getWalletInfo","parameters":[{"name":"walletId","required":false,"in":"query","description":"LNbits wallet id on my account (empty = default)","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my wallet info + balance (auto-provisions on first access)","tags":["My Wallet"]}},"/api/v1/my-wallet/wallets":{"get":{"operationId":"listAccountWallets","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List all wallets on my LNbits account (default flagged, live balances)","tags":["My Wallet"]},"post":{"operationId":"createAccountWallet","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a new wallet on my LNbits account","tags":["My Wallet"]}},"/api/v1/my-wallet/wallets/{id}":{"patch":{"operationId":"updateAccountWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Rename a wallet or change its color","tags":["My Wallet"]},"delete":{"operationId":"deleteAccountWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a wallet from my account (not the default one)","tags":["My Wallet"]}},"/api/v1/my-wallet/wallets/{id}/default":{"post":{"operationId":"setDefaultAccountWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Make one of my wallets the default (receives funds for links/NIP-5/projects)","tags":["My Wallet"]}},"/api/v1/my-wallet/payments":{"get":{"operationId":"getPayments","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my wallet payments","tags":["My Wallet"]}},"/api/v1/my-wallet/payments/export/csv":{"get":{"description":"Downloads up to 5,000 payments matching the filters as a CSV file — for accounting/reconciliation.","operationId":"exportPaymentsCsv","parameters":[{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Export wallet payments as CSV","tags":["My Wallet"]}},"/api/v1/my-wallet/payments/history":{"get":{"operationId":"getPaymentsHistory","parameters":[{"name":"group","required":false,"in":"query","schema":{"enum":["hour","day","month"],"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my payments history for charts","tags":["My Wallet"]}},"/api/v1/my-wallet/payments/{paymentHash}/status":{"get":{"operationId":"checkPaymentStatus","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check payment status","tags":["My Wallet"]}},"/api/v1/my-wallet/invoices/{paymentHash}/cancel":{"post":{"operationId":"cancelInvoice","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel a pending invoice on my wallet","tags":["My Wallet"]}},"/api/v1/my-wallet/invoices":{"post":{"operationId":"createInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create invoice (receive sats into my wallet)","tags":["My Wallet"]}},"/api/v1/my-wallet/pay":{"post":{"operationId":"payInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay a BOLT11 invoice (send sats from my wallet)","tags":["My Wallet"]}},"/api/v1/my-wallet/pay/lnurl":{"post":{"operationId":"payLnurl","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay an LNURL or lightning address","tags":["My Wallet"]}},"/api/v1/my-wallet/lnurl/scan":{"post":{"operationId":"lnurlScan","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Scan/decode an LNURL or lightning address","tags":["My Wallet"]}},"/api/v1/my-wallet/decode":{"post":{"operationId":"decodeInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Decode a BOLT11 invoice","tags":["My Wallet"]}},"/api/v1/my-wallet/pay-links":{"get":{"operationId":"getLnurlPayLinks","parameters":[{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my LNURL-pay links","tags":["My Wallet"]},"post":{"operationId":"createLnurlPayLink","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create an LNURL-pay link on my wallet","tags":["My Wallet"]}},"/api/v1/my-wallet/pay-links/{linkId}":{"delete":{"operationId":"deleteLnurlPayLink","parameters":[{"name":"linkId","required":true,"in":"path","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete an LNURL-pay link","tags":["My Wallet"]}},"/api/v1/my-wallet/access":{"get":{"operationId":"getWalletAccess","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"How I can access my LNbits wallet account (magic link, username/password, nostr)","tags":["My Wallet"]}},"/api/v1/my-wallet/access/magic-link":{"post":{"operationId":"getMagicLink","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"One-click magic link into my LNbits wallet UI","tags":["My Wallet"]}},"/api/v1/my-wallet/access/credentials":{"post":{"operationId":"setCredentials","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Set username + password for LNbits login","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/domains":{"get":{"operationId":"getNip5Domains","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List all NIP-5 domains I can buy a lightning address on","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/domains/{domainId}":{"get":{"operationId":"getNip5DomainDetail","parameters":[{"name":"domainId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Domain detail with real pricing tiers","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/search":{"get":{"operationId":"searchNip5","parameters":[{"name":"domainId","required":true,"in":"query","schema":{"type":"string"}},{"name":"identifier","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check identifier availability + exact price","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/addresses":{"post":{"operationId":"registerNip5","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Buy my lightning address — returns the pending address + BOLT11 invoice at the real LNbits price","tags":["My Wallet"]},"get":{"operationId":"getNip5Addresses","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my lightning addresses on the instance","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/pay":{"post":{"operationId":"payNip5Purchase","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay the NIP-5 purchase invoice from my wallet balance","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/payments/{paymentHash}":{"get":{"operationId":"checkNip5Purchase","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"domainId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check whether my NIP-5 purchase is paid (activates the address)","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/purchases/{domainId}/{addressId}":{"delete":{"operationId":"cancelNip5Purchase","parameters":[{"name":"domainId","required":true,"in":"path","schema":{"type":"string"}},{"name":"addressId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel a pending (unpaid) NIP-5 purchase","tags":["My Wallet"]}},"/api/v1/my-wallet/nip5/addresses/{domainId}/{addressId}":{"post":{"operationId":"updateNip5Address","parameters":[{"name":"domainId","required":true,"in":"path","schema":{"type":"string"}},{"name":"addressId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Update one of my lightning addresses (pubkey / relays)","tags":["My Wallet"]},"delete":{"operationId":"deleteNip5Address","parameters":[{"name":"domainId","required":true,"in":"path","schema":{"type":"string"}},{"name":"addressId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete one of my lightning addresses","tags":["My Wallet"]}},"/api/v1/my-wallet/nostr":{"get":{"operationId":"getNostrProfile","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my nostr profile","tags":["My Wallet"]}},"/api/v1/my-wallet/nostr/generate":{"post":{"operationId":"generateNostr","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Generate a brand-new nostr keypair (shows nsec once)","tags":["My Wallet"]}},"/api/v1/my-wallet/nostr/link":{"post":{"operationId":"linkNostr","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Link my existing nostr identity (npub — we never hold your key)","tags":["My Wallet"]}},"/api/v1/my-wallet/nostr/reveal":{"post":{"operationId":"revealNsec","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Reveal my generated nsec (only if ZapAPI generated it)","tags":["My Wallet"]}},"/api/v1/my-wallet/identities":{"get":{"operationId":"listIdentities","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List all my identities (primary first)","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/generate":{"post":{"operationId":"generateIdentity","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Generate a new identity (nsec shown once)","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/link":{"post":{"operationId":"linkIdentity","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Attach an external identity (npub — we never hold the key)","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/{id}/primary":{"post":{"operationId":"setPrimaryIdentity","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Make an identity my primary (zaps, NIP-5, wallet login)","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/{id}/reveal":{"post":{"operationId":"revealIdentityNsec","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Reveal a generated identity nsec","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/{id}/recheck":{"post":{"operationId":"recheckIdentity","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Re-check whether a wallet exists with this key on the instance","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/{id}/rename":{"post":{"operationId":"renameIdentity","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Rename an identity label","tags":["My Wallet"]}},"/api/v1/my-wallet/identities/{id}":{"delete":{"operationId":"deleteIdentity","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Remove an identity (not the primary one)","tags":["My Wallet"]}},"/api/v1/fx/currencies":{"get":{"operationId":"getCurrencies","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"List supported fiat currencies","tags":["fx"]}},"/api/v1/fx/rates":{"get":{"operationId":"getRates","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Current BTC price in all supported currencies","tags":["fx"]}},"/api/v1/fx/rate/{currency}":{"get":{"operationId":"getRate","parameters":[{"name":"currency","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Current BTC price in one currency","tags":["fx"]}},"/api/v1/fx/convert":{"get":{"operationId":"convert","parameters":[{"name":"sats","required":true,"in":"query","schema":{"type":"string"}},{"name":"currency","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Convert sats to fiat (display quote)","tags":["fx"]}},"/api/v1/nostr/profile":{"get":{"operationId":"fetchProfile","parameters":[{"name":"identityId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Fetch the newest kind 0 profile for an identity from the relay set (relay.nostrfeed.com first)","tags":["Nostr Profile"]},"post":{"operationId":"publishProfile","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Publish a kind 0 profile update (merged with relay-current). Signed with the identity key — generated identities only.","tags":["Nostr Profile"]}},"/api/v1/nostr/signer":{"get":{"operationId":"getMySigner","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my connected remote signer (or null)","tags":["nostr"]},"delete":{"operationId":"disconnect","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Disconnect the signer — receipts fall back to the platform key","tags":["nostr"]}},"/api/v1/nostr/signer/connect":{"post":{"description":"Performs the NIP-46 handshake (connect + get_public_key) and stores the URI encrypted. Replaces any existing connection.","operationId":"connect","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Signer connected"},"400":{"description":"Invalid URI or signer unreachable"}},"security":[{"bearer":[]}],"summary":"Connect a bunker:// remote signer","tags":["nostr"]}},"/api/v1/nostr/signer/test":{"post":{"operationId":"test","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Ping the connected signer","tags":["nostr"]}},"/api/v1/nostr/profiles/{pubkey}":{"get":{"operationId":"getProfile","parameters":[{"name":"pubkey","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Resolve a kind 0 profile by hex pubkey (layered: Redis → DB → SWR relay refresh)","tags":["Nostr Profiles (public)"]}},"/api/v1/nostr/profiles":{"get":{"operationId":"getProfiles","parameters":[{"name":"pubkeys","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Batch resolve kind 0 profiles (?pubkeys=hex,hex,… — max 25)","tags":["Nostr Profiles (public)"]}},"/api/v1/nostr/zaps/mine":{"get":{"operationId":"getMyZaps","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My zap feed — zaps I received, with lifetime totals","tags":["nostr"]}},"/api/v1/nostr/zaps/public/{address}":{"get":{"operationId":"getPublicFeed","parameters":[{"name":"address","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Public zap feed for a lightning address (settled zaps only)","tags":["nostr"]}},"/api/v1/scrub/rule":{"get":{"operationId":"getRule","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my scrub rule (null when none)","tags":["Scrub"]},"put":{"description":"Every incoming payment above the reserve forwards automatically to the destination lightning address. Splits run first; scrub sees what settles.","operationId":"upsertRule","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Create or replace the scrub rule","tags":["Scrub"]},"delete":{"operationId":"deleteRule","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete the scrub rule","tags":["Scrub"]}},"/api/v1/scrub/executions":{"get":{"operationId":"listExecutions","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Forward history (audit trail)","tags":["Scrub"]}},"/api/v1/users":{"post":{"description":"Creates a new user with email, first name, last name, and password. Password must be at least 8 characters with uppercase, lowercase, number, and special character. Requires Admin role.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserDto"}}}},"responses":{"201":{"description":"User has been successfully created.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":201,"message":"User created successfully","data":{"id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","email":"john.doe@example.com","firstName":"John","lastName":"Doe","isActive":true,"createdAt":"2026-01-27T10:23:22.983Z","updatedAt":"2026-01-27T10:23:22.983Z"},"meta":{"user_id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","created_at":"2026-01-27T10:23:22.983Z"},"timestamp":"2026-01-27T10:23:22.997Z","path":"/api/v1/users"}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"User with this email already exists","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users"}]}}}}},"security":[{"bearer":[]}],"summary":"Create a new user (Admin only)","tags":["users"]},"get":{"description":"Retrieves a paginated list of users. Use page and limit query parameters to control pagination. Requires Admin or Moderator role.","operationId":"findAll","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (default: 1)","schema":{"type":"number","examples":[1]}},{"name":"limit","required":false,"in":"query","description":"Items per page (default: 10)","schema":{"type":"number","examples":[10]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Return all users with pagination.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Users fetched successfully","data":[{"id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","email":"john.doe@example.com","firstName":"John","lastName":"Doe","isActive":true,"createdAt":"2026-01-27T10:23:22.983Z","updatedAt":"2026-01-27T10:23:22.983Z"}],"meta":{"total":25,"count":10,"page":2,"limit":10,"total_pages":3,"has_next":true,"has_previous":true,"timestamp":"2026-01-27T10:28:36.014Z"},"timestamp":"2026-01-27T10:28:36.014Z","path":"/api/v1/users"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all users with pagination (Admin/Moderator)","tags":["users"]}},"/api/v1/users/statistics":{"get":{"description":"Retrieves user statistics including total, active, inactive, and today registered counts. Requires Admin or Moderator role.","operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"User statistics retrieved successfully.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Statistics fetched successfully","data":{"total":125,"active":98,"inactive":27,"pending":0,"todayRegistered":5},"meta":{"cached":false,"timestamp":"2026-01-31T10:00:00.000Z"},"timestamp":"2026-01-31T10:00:00.015Z","path":"/api/v1/users/statistics"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/statistics"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get user statistics (Admin/Moderator)","tags":["users"]}},"/api/v1/users/{id}":{"get":{"description":"Retrieves a single user by their UUID. Returns cached data if available.","operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","description":"User UUID","schema":{"type":"string","examples":["6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Return the user.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"User fetched successfully","data":{"id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","email":"john.doe@example.com","firstName":"John","lastName":"Doe","isActive":true,"createdAt":"2026-01-27T10:23:22.983Z","updatedAt":"2026-01-27T10:23:22.983Z"},"meta":{"cached":true},"timestamp":"2026-01-27T10:28:36.014Z","path":"/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"}]}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"User not found","timestamp":"2026-01-27T10:28:36.014Z","path":"/api/v1/users/invalid-id"}]}}}}},"security":[{"bearer":[]}],"summary":"Get a user by ID","tags":["users"]},"patch":{"description":"Updates an existing user. All fields are optional. Cache is invalidated after update.","operationId":"update","parameters":[{"name":"id","required":true,"in":"path","description":"User UUID","schema":{"type":"string","examples":["6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":"User has been successfully updated.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"User updated successfully","data":{"id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","email":"john.updated@example.com","firstName":"John","lastName":"Doe","isActive":true,"createdAt":"2026-01-27T10:23:22.983Z","updatedAt":"2026-01-27T10:30:00.000Z"},"meta":{"user_id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","updated_at":"2026-01-27T10:30:00.000Z"},"timestamp":"2026-01-27T10:30:00.015Z","path":"/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","timestamp":"2026-01-27T10:30:00.015Z","path":"/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"}]}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"User not found","timestamp":"2026-01-27T10:30:00.015Z","path":"/api/v1/users/invalid-id"}]}}}},"409":{"description":"Conflict - Email already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Email already exists","timestamp":"2026-01-27T10:30:00.015Z","path":"/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"}]}}}}},"security":[{"bearer":[]}],"summary":"Update a user","tags":["users"]},"delete":{"description":"Permanently deletes a user by their UUID. Cache is invalidated after deletion.","operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","description":"User UUID","schema":{"type":"string","examples":["6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"User has been successfully deleted.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"User deleted successfully","data":null,"meta":{"user_id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","deleted_at":"2026-01-27T10:35:00.000Z"},"timestamp":"2026-01-27T10:35:00.015Z","path":"/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"}]}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"User not found","timestamp":"2026-01-27T10:35:00.015Z","path":"/api/v1/users/invalid-id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete a user","tags":["users"]}},"/api/v1/users/search/advanced":{"get":{"description":"Search users with filters (search query, active status), sorting, and pagination.","operationId":"search","parameters":[{"name":"search","required":false,"in":"query","description":"Search query for name or email","schema":{"type":"string","examples":["john"]}},{"name":"isActive","required":false,"in":"query","description":"Filter by active status","schema":{"type":"string","examples":["true"]}},{"name":"sortBy","required":false,"in":"query","description":"Sort by field","schema":{"enum":["email","firstName","lastName","createdAt","isActive"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort direction","schema":{"enum":["asc","desc"],"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number","schema":{"minimum":1,"type":"number","examples":[1]}},{"name":"limit","required":false,"in":"query","description":"Items per page","schema":{"minimum":1,"type":"number","examples":[10]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Users search results with filters and pagination.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Users searched successfully","data":[{"id":"6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe","email":"john.doe@example.com","firstName":"John","lastName":"Doe","isActive":true,"createdAt":"2026-01-27T10:23:22.983Z","updatedAt":"2026-01-27T10:23:22.983Z"}],"meta":{"total":15,"count":10,"page":1,"limit":10,"total_pages":2,"has_next":true,"has_previous":false,"search_query":"john","filters":{"isActive":"true"},"sort":{"field":"email","order":"asc"}},"timestamp":"2026-01-27T10:40:00.000Z","path":"/api/v1/users/search/advanced"}]}}}}},"security":[{"bearer":[]}],"summary":"Advanced search for users","tags":["users"]}},"/api/v1/users/bulk/activate":{"post":{"description":"Activates multiple users by their IDs.","operationId":"bulkActivate","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUserIdsDto"}}}},"responses":{"200":{"description":"Users have been successfully activated.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Successfully activated 5 user(s)","data":{"affected":5},"meta":{"requested":5,"affected":5,"operation":"activate"},"timestamp":"2026-01-27T10:45:00.000Z","path":"/api/v1/users/bulk/activate"}]}}}}},"security":[{"bearer":[]}],"summary":"Bulk activate users","tags":["users"]}},"/api/v1/users/bulk/deactivate":{"post":{"description":"Deactivates multiple users by their IDs.","operationId":"bulkDeactivate","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUserIdsDto"}}}},"responses":{"200":{"description":"Users have been successfully deactivated.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Successfully deactivated 3 user(s)","data":{"affected":3},"meta":{"requested":3,"affected":3,"operation":"deactivate"},"timestamp":"2026-01-27T10:50:00.000Z","path":"/api/v1/users/bulk/deactivate"}]}}}}},"security":[{"bearer":[]}],"summary":"Bulk deactivate users","tags":["users"]}},"/api/v1/users/bulk":{"delete":{"description":"Permanently deletes multiple users by their IDs.","operationId":"bulkDelete","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUserIdsDto"}}}},"responses":{"200":{"description":"Users have been successfully deleted.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Successfully deleted 2 user(s)","data":{"affected":2},"meta":{"requested":2,"affected":2,"operation":"delete"},"timestamp":"2026-01-27T10:55:00.000Z","path":"/api/v1/users/bulk"}]}}}}},"security":[{"bearer":[]}],"summary":"Bulk delete users","tags":["users"]}},"/api/v1/roles":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleDto"}}}},"responses":{"201":{"description":"Role created successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Role already exists","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles"}]}}}}},"security":[{"bearer":[]}],"summary":"Create a new role (Admin only)","tags":["RBAC - Roles"]},"get":{"operationId":"findAll","parameters":[{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Roles fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all roles with pagination","tags":["RBAC - Roles"]}},"/api/v1/roles/statistics":{"get":{"operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Role statistics fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get role statistics","tags":["RBAC - Roles"]}},"/api/v1/roles/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Role fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}},"404":{"description":"Not Found - Role not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Role not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Get role by ID","tags":["RBAC - Roles"]},"put":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoleDto"}}}},"responses":{"200":{"description":"Role updated successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}},"404":{"description":"Not Found - Role not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Role not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Update role (Admin only)","tags":["RBAC - Roles"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Role deleted successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}},"404":{"description":"Not Found - Role not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Role not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/roles/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete role (Admin only)","tags":["RBAC - Roles"]}},"/api/v1/permissions":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePermissionDto"}}}},"responses":{"201":{"description":"Permission created successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Permission already exists","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions"}]}}}}},"security":[{"bearer":[]}],"summary":"Create a new permission (Admin only)","tags":["RBAC - Permissions"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Permissions fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all permissions","tags":["RBAC - Permissions"]}},"/api/v1/permissions/statistics":{"get":{"operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Permission statistics fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get permission statistics","tags":["RBAC - Permissions"]}},"/api/v1/permissions/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Permission fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"404":{"description":"Not Found - Permission not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Permission not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Get a permission by ID","tags":["RBAC - Permissions"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePermissionDto"}}}},"responses":{"200":{"description":"Permission updated successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"404":{"description":"Not Found - Permission not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Permission not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Permission with this name already exists","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Update a permission (Admin only)","tags":["RBAC - Permissions"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Permission deleted successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}},"404":{"description":"Not Found - Permission not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Permission not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/permissions/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete a permission (Admin only)","tags":["RBAC - Permissions"]}},"/api/v1/users/{userId}/roles":{"post":{"operationId":"assignRoles","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignRoleDto"}}}},"responses":{"200":{"description":"Roles assigned successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles"}]}}}},"404":{"description":"Not Found - User not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"User not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles"}]}}}}},"security":[{"bearer":[]}],"summary":"Assign roles to user (Admin only)","tags":["RBAC - User Roles"]},"get":{"operationId":"getUserRoles","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"User roles fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles"}]}}}},"404":{"description":"Not Found - User not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"User not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles"}]}}}}},"security":[{"bearer":[]}],"summary":"Get user roles","tags":["RBAC - User Roles"]}},"/api/v1/users/{userId}/roles/{roleId}":{"delete":{"operationId":"removeRole","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"roleId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Role removed successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles/:roleId"}]}}}},"403":{"description":"Forbidden - Insufficient permissions.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":403,"message":"Forbidden resource","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles/:roleId"}]}}}},"404":{"description":"Not Found - User or Role not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"User or Role not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/users/:userId/roles/:roleId"}]}}}}},"security":[{"bearer":[]}],"summary":"Remove role from user (Admin only)","tags":["RBAC - User Roles"]}},"/api/v1/newsletter/subscribe":{"post":{"operationId":"subscribe","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeNewsletterDto"}}}},"responses":{"201":{"description":"Successfully subscribed to newsletter","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":201,"message":"Successfully subscribed to newsletter","data":{"id":"123e4567-e89b-12d3-a456-426614174000","email":"user@example.com","firstName":"John","lastName":"Doe","isActive":true,"subscribedAt":"2026-02-01T10:00:00.000Z"},"meta":{"subscriber_id":"123e4567-e89b-12d3-a456-426614174000","subscribed_at":"2026-02-01T10:00:00.000Z"}}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/subscribe"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Email already subscribed to newsletter","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/subscribe"}]}}}}},"summary":"Subscribe to newsletter (public)","tags":["newsletter"]}},"/api/v1/newsletter/unsubscribe/{email}":{"post":{"operationId":"unsubscribe","parameters":[{"name":"email","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Successfully unsubscribed from newsletter","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Successfully unsubscribed from newsletter","meta":{"unsubscribed_at":"2026-02-01T10:00:00.000Z"}}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/unsubscribe/:email"}]}}}},"404":{"description":"Not Found - Email not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Email not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/unsubscribe/:email"}]}}}}},"summary":"Unsubscribe from newsletter (public)","tags":["newsletter"]}},"/api/v1/newsletter":{"get":{"operationId":"findAll","parameters":[{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Newsletter subscribers fetched successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Newsletter subscribers fetched successfully","data":[{"id":"123e4567-e89b-12d3-a456-426614174000","email":"user@example.com","firstName":"John","lastName":"Doe","isActive":true,"subscribedAt":"2026-02-01T10:00:00.000Z"}],"meta":{"total":100,"count":50,"page":1,"limit":50,"total_pages":2,"has_next":true,"has_previous":false}}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all newsletter subscribers (admin)","tags":["newsletter"]}},"/api/v1/newsletter/statistics":{"get":{"operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Newsletter statistics fetched successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Newsletter statistics fetched successfully","data":{"total":1000,"active":850,"inactive":150,"todaySubscribed":25}}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get newsletter statistics (admin)","tags":["newsletter"]}},"/api/v1/newsletter/send":{"post":{"operationId":"sendNewsletter","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNewsletterDto"}}}},"responses":{"200":{"description":"Newsletter sent successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Newsletter sent successfully","meta":{"total_subscribers":850,"sent":845,"failed":5}}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/send"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/send"}]}}}}},"security":[{"bearer":[]}],"summary":"Send newsletter to all active subscribers (admin)","tags":["newsletter"]}},"/api/v1/newsletter/subscribers":{"post":{"operationId":"addSubscriber","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeNewsletterDto"}}}},"responses":{"201":{"description":"Subscriber added successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/subscribers"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/subscribers"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Email already subscribed to newsletter","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/subscribers"}]}}}}},"security":[{"bearer":[]}],"summary":"Add a subscriber manually (admin)","tags":["newsletter"]}},"/api/v1/newsletter/{id}":{"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberDto"}}}},"responses":{"200":{"description":"Subscriber updated successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/:id"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/:id"}]}}}},"404":{"description":"Not Found - Subscriber not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Subscriber not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/:id"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Another subscriber already uses this email","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Update a newsletter subscriber (admin)","tags":["newsletter"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Subscriber deleted successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Subscriber deleted successfully","meta":{"deleted_id":"123e4567-e89b-12d3-a456-426614174000"}}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/:id"}]}}}},"404":{"description":"Not Found - Subscriber not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Subscriber not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/newsletter/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete newsletter subscriber (admin)","tags":["newsletter"]}},"/api/v1/analytics/track":{"post":{"operationId":"trackVisitor","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackVisitorDto"}}}},"responses":{"201":{"description":"Visitor tracked successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":201,"message":"Visitor tracked successfully","data":{"tracked":true,"visitorId":"uuid"}}]}}}}},"summary":"Track website visitor","tags":["analytics"]}},"/api/v1/analytics/dashboard":{"get":{"operationId":"getAnalytics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Analytics data fetched successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Analytics fetched successfully","data":{"overview":{"totalVisitors":1250,"uniqueVisitors":850,"todayVisitors":45,"weekVisitors":320,"monthVisitors":1150,"returningVisitors":400,"newVisitors":850},"topCountries":[{"country":"United States","countryCode":"US","count":450},{"country":"India","countryCode":"IN","count":320}],"topCities":[{"city":"New York","country":"United States","count":120}],"topPages":[{"page":"/","count":500},{"page":"/about","count":250}],"browserStats":[{"browser":"Chrome","count":800},{"browser":"Safari","count":300}],"osStats":[{"os":"Windows","count":600},{"os":"Mac OS","count":400}],"deviceStats":[{"device":"desktop","count":800},{"device":"mobile","count":400}]}}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/analytics/dashboard"}]}}}}},"security":[{"bearer":[]}],"summary":"Get analytics dashboard data","tags":["analytics"]}},"/api/v1/analytics/trend":{"get":{"operationId":"getVisitorTrend","parameters":[{"name":"days","required":false,"in":"query","schema":{"type":"number","examples":[7]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Visitor trend fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/analytics/trend"}]}}}}},"security":[{"bearer":[]}],"summary":"Get daily visitor trend for the last N days","tags":["analytics"]}},"/api/v1/analytics/recent":{"get":{"operationId":"getRecentVisitors","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"number","examples":[50]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Recent visitors fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/analytics/recent"}]}}}}},"security":[{"bearer":[]}],"summary":"Get recent visitors","tags":["analytics"]}},"/api/v1/contact":{"post":{"description":"Public endpoint for contact form submissions. Sends email to admin.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactDto"}}}},"responses":{"201":{"description":"Contact form submitted successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":201,"message":"Thank you for contacting us! We will get back to you soon.","data":{"id":"uuid","name":"John Doe","email":"john@example.com","subject":"General Inquiry","message":"I would like to know more...","status":"new","createdAt":"2026-02-01T10:00:00.000Z"},"meta":{"contact_id":"uuid","created_at":"2026-02-01T10:00:00.000Z"}}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact"}]}}}}},"summary":"Submit contact form","tags":["contact"]},"get":{"description":"Admin endpoint to retrieve contact submissions with pagination and filtering","operationId":"findAll","parameters":[{"name":"page","required":false,"in":"query","description":"Page number","schema":{"type":"number","examples":[1]}},{"name":"limit","required":false,"in":"query","description":"Items per page","schema":{"type":"number","examples":[20]}},{"name":"status","required":false,"in":"query","description":"Filter by status","schema":{"type":"string","examples":["new"]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Contact submissions fetched successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Contact submissions fetched successfully","data":[{"id":"uuid","name":"John Doe","email":"john@example.com","phone":"+1234567890","subject":"General Inquiry","message":"I would like to know more...","status":"new","ipAddress":"192.168.1.1","createdAt":"2026-02-01T10:00:00.000Z"}],"meta":{"total":50,"count":20,"page":1,"limit":20,"total_pages":3,"has_next":true,"has_previous":false}}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all contact submissions","tags":["contact"]}},"/api/v1/contact/statistics":{"get":{"description":"Admin endpoint to get contact submission statistics","operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Statistics fetched successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"Contact statistics fetched successfully","data":{"total":150,"new":25,"read":50,"replied":60,"today":5}}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get contact statistics","tags":["contact"]}},"/api/v1/contact/{id}":{"get":{"description":"Admin endpoint to get single contact submission. Auto-marks as read.","operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Contact submission fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/:id"}]}}}},"404":{"description":"Not Found - Contact not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Contact not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Get contact submission by ID","tags":["contact"]},"patch":{"description":"Admin endpoint to update contact submission status","operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactDto"}}}},"responses":{"200":{"description":"Contact status updated successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/:id"}]}}}},"404":{"description":"Not Found - Contact not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Contact not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Update contact status","tags":["contact"]},"delete":{"description":"Admin endpoint to delete contact submission","operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Contact submission deleted successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/:id"}]}}}},"404":{"description":"Not Found - Contact not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Contact not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/contact/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete contact submission","tags":["contact"]}},"/api/v1/blog":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlogPostDto"}}}},"responses":{"201":{"description":"Blog post created successfully","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":201,"message":"Blog post created successfully","data":{"id":"uuid","title":"How to Build a Modern Web App","slug":"how-to-build-a-modern-web-app","content":"

Introduction

","status":"draft","readTime":5,"createdAt":"2026-02-02T10:00:00.000Z"},"meta":{"blog_post_id":"uuid","slug":"how-to-build-a-modern-web-app","created_at":"2026-02-02T10:00:00.000Z"}}]}}}},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog"}]}}}}},"security":[{"bearer":[]}],"summary":"Create a new blog post","tags":["blog"]}},"/api/v1/blog/admin":{"get":{"operationId":"findAll","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"category","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Blog posts fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/admin"}]}}}}},"security":[{"bearer":[]}],"summary":"Get all blog posts (admin)","tags":["blog"]}},"/api/v1/blog/published":{"get":{"operationId":"findPublished","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"category","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Published blog posts fetched successfully"}},"summary":"Get published blog posts (public)","tags":["blog"]}},"/api/v1/blog/slug/{slug}":{"get":{"operationId":"findBySlug","parameters":[{"name":"slug","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Blog post fetched successfully"},"404":{"description":"Not Found - Blog post not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Blog post not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/slug/:slug"}]}}}}},"summary":"Get blog post by slug (public)","tags":["blog"]}},"/api/v1/blog/statistics":{"get":{"operationId":"getStatistics","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Blog statistics fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/statistics"}]}}}}},"security":[{"bearer":[]}],"summary":"Get blog statistics","tags":["blog"]}},"/api/v1/blog/categories":{"get":{"operationId":"getCategories","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Categories fetched successfully"}},"summary":"Get all blog categories with post counts","tags":["blog"]},"post":{"operationId":"createCategory","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlogCategoryDto"}}}},"responses":{"201":{"description":"Category created successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories"}]}}}},"409":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":409,"message":"Category already exists","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories"}]}}}}},"security":[{"bearer":[]}],"summary":"Create new blog category with SEO fields","tags":["blog"]}},"/api/v1/blog/categories/{id}":{"get":{"operationId":"getCategoryById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Category fetched successfully"},"404":{"description":"Not Found - Category not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Category not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories/:id"}]}}}}},"summary":"Get blog category by ID","tags":["blog"]},"patch":{"operationId":"updateCategory","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlogCategoryDto"}}}},"responses":{"200":{"description":"Category updated successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories/:id"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories/:id"}]}}}},"404":{"description":"Not Found - Category not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Category not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Update blog category","tags":["blog"]},"delete":{"operationId":"deleteCategory","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Category deleted successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories/:id"}]}}}},"404":{"description":"Not Found - Category not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Category not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/categories/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete blog category","tags":["blog"]}},"/api/v1/blog/tags":{"get":{"operationId":"getTags","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Tags fetched successfully"}},"summary":"Get all blog tags","tags":["blog"]}},"/api/v1/blog/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Blog post fetched successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}},"404":{"description":"Not Found - Blog post not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Blog post not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Get blog post by ID","tags":["blog"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlogPostDto"}}}},"responses":{"200":{"description":"Blog post updated successfully"},"400":{"description":"Bad Request - Validation failed.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":400,"message":"Validation failed","errors":["Field is required","Invalid format"],"timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}},"404":{"description":"Not Found - Blog post not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Blog post not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Update blog post","tags":["blog"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Blog post deleted successfully"},"401":{"description":"Unauthorized - Invalid or missing JWT token.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":401,"message":"Unauthorized","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}},"404":{"description":"Not Found - Blog post not found.","content":{"application/json":{"schema":{"examples":[{"status":"error","statusCode":404,"message":"Blog post not found","timestamp":"2026-01-31T19:20:00.000Z","path":"/api/v1/blog/:id"}]}}}}},"security":[{"bearer":[]}],"summary":"Delete blog post","tags":["blog"]}},"/api/v1/projects":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectDto"}}}},"responses":{"201":{"description":"Project created successfully"},"401":{"description":"Unauthorized"}},"security":[{"bearer":[]}],"summary":"Create a new project","tags":["Projects"]},"get":{"operationId":"findAll","parameters":[{"name":"environment","required":false,"in":"query","schema":{"enum":["development","production"],"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Projects retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all projects","tags":["Projects"]}},"/api/v1/projects/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Project retrieved successfully"},"403":{"description":"Access denied"},"404":{"description":"Project not found"}},"security":[{"bearer":[]}],"summary":"Get a single project","tags":["Projects"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectDto"}}}},"responses":{"200":{"description":"Project updated successfully"},"404":{"description":"Project not found"}},"security":[{"bearer":[]}],"summary":"Update a project","tags":["Projects"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Project deleted successfully"},"404":{"description":"Project not found"}},"security":[{"bearer":[]}],"summary":"Delete a project","tags":["Projects"]}},"/api/v1/projects/{id}/stats":{"get":{"operationId":"getStats","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Statistics retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get project statistics","tags":["Projects"]}},"/api/v1/projects/{id}/wallet":{"get":{"operationId":"getProjectWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get the project settlement wallet (default / dedicated / account / nwc / provider)","tags":["Projects"]},"patch":{"operationId":"setProjectWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Link the settlement wallet: 'default' | 'account:' | 'nwc:' | 'provider:' (legacy)","tags":["Projects"]}},"/api/v1/projects/{id}/wallet/dedicated":{"post":{"operationId":"createDedicatedWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a dedicated LNbits wallet for this project and link it as the settlement wallet","tags":["Projects"]}},"/api/v1/projects/members/pending":{"get":{"operationId":"listPending","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My pending invitations (accept/decline here)","tags":["Projects"]}},"/api/v1/projects/shared":{"get":{"operationId":"listShared","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Projects shared with me (I am a member)","tags":["Projects"]}},"/api/v1/projects/{projectId}/members":{"get":{"operationId":"listMembers","parameters":[{"name":"projectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List project members (viewer+)","tags":["Projects"]},"post":{"description":"The invited user must have a ZapAPI account. Role: editor (read+write) or viewer (read-only).","operationId":"invite","parameters":[{"name":"projectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Invite a member by email (owner only)","tags":["Projects"]}},"/api/v1/projects/members/{memberId}/accept":{"post":{"operationId":"accept","parameters":[{"name":"memberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Accept an invitation","tags":["Projects"]}},"/api/v1/projects/members/{memberId}/role":{"patch":{"operationId":"updateRole","parameters":[{"name":"memberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Change a member role (owner only)","tags":["Projects"]}},"/api/v1/projects/members/{memberId}":{"delete":{"operationId":"revoke","parameters":[{"name":"memberId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Revoke membership or decline an invitation","tags":["Projects"]}},"/api/v1/providers":{"post":{"description":"`type=lnbits` (BYO external wallet via URL + keys) has been removed — external wallets connect exclusively via NWC (`POST /nwc-connections`).","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProviderDto"}}}},"responses":{"201":{"description":"Provider created successfully"},"400":{"description":"type=lnbits is no longer supported — use NWC connections"}},"security":[{"bearer":[]}],"summary":"Create a new provider connection","tags":["Providers"]},"get":{"operationId":"findAll","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Providers retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all providers","tags":["Providers"]}},"/api/v1/providers/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Provider retrieved successfully"},"404":{"description":"Provider not found"}},"security":[{"bearer":[]}],"summary":"Get a single provider","tags":["Providers"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Provider deleted successfully"},"404":{"description":"Provider not found"}},"security":[{"bearer":[]}],"summary":"Delete a provider","tags":["Providers"]}},"/api/v1/providers/{id}/test":{"post":{"operationId":"testConnection","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Connection test completed"}},"security":[{"bearer":[]}],"summary":"Test provider connection","tags":["Providers"]}},"/api/v1/providers/{id}/disconnect":{"post":{"operationId":"disconnect","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Provider disconnected successfully"}},"security":[{"bearer":[]}],"summary":"Disconnect provider","tags":["Providers"]}},"/api/v1/api-keys":{"post":{"description":"Creates a new API key. The full key is only shown ONCE - save it securely!","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyDto"}}}},"responses":{"201":{"description":"API key created successfully. Full key is returned only once."}},"security":[{"bearer":[]}],"summary":"Create a new API key","tags":["API Keys"]},"get":{"operationId":"findAll","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"API keys retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all API keys","tags":["API Keys"]}},"/api/v1/api-keys/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"API key retrieved successfully"},"404":{"description":"API key not found"}},"security":[{"bearer":[]}],"summary":"Get a single API key","tags":["API Keys"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"API key deleted successfully"},"404":{"description":"API key not found"}},"security":[{"bearer":[]}],"summary":"Delete an API key","tags":["API Keys"]}},"/api/v1/api-keys/{id}/revoke":{"post":{"operationId":"revoke","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"API key revoked successfully"},"404":{"description":"API key not found"}},"security":[{"bearer":[]}],"summary":"Revoke an API key","tags":["API Keys"]}},"/api/v1/invoices/public/{id}":{"get":{"description":"Safe public fields for rendering the hosted checkout: amount, description, bolt11, status, expiry, merchant name, success/cancel URLs.","operationId":"getPublicView","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public invoice view (hosted checkout page)","tags":["Invoices"]}},"/api/v1/invoices":{"post":{"description":"Creates a BOLT11 invoice settling to the project's settlement wallet (linked on the dashboard — default wallet when none is linked). projectId is optional for project-scoped API keys. Authenticate with a zap_live_/zap_test_ API key (invoices:write scope) or a dashboard JWT. Test keys create testMode invoices (webhook livemode: false). Supports fiat denominations via the currency field.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceDto"}}}},"responses":{"201":{"description":"Invoice created successfully"},"400":{"description":"Invalid request"}},"security":[{"bearer":[]}],"summary":"Create a new Lightning invoice","tags":["Invoices"]},"get":{"operationId":"findAll","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"enum":["pending","partial","paid","expired","cancelled"],"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Invoices retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all invoices","tags":["Invoices"]}},"/api/v1/invoices/export/csv":{"get":{"description":"Downloads ALL invoices matching the filters (no pagination limit) as a CSV file — for accounting/reconciliation.","operationId":"exportCsv","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"enum":["pending","partial","paid","expired","cancelled"],"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"CSV file download","content":{"text/csv":{}}}},"security":[{"bearer":[]}],"summary":"Export invoices as CSV","tags":["Invoices"]}},"/api/v1/invoices/stats":{"get":{"operationId":"getStats","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Statistics retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get invoice statistics","tags":["Invoices"]}},"/api/v1/invoices/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Invoice retrieved successfully"},"404":{"description":"Invoice not found"}},"security":[{"bearer":[]}],"summary":"Get a single invoice","tags":["Invoices"]}},"/api/v1/invoices/{id}/status":{"get":{"operationId":"checkStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Status retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Check invoice status (polls provider for updates)","tags":["Invoices"]}},"/api/v1/invoices/{id}/cancel":{"post":{"operationId":"cancel","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Invoice cancelled successfully"},"400":{"description":"Invoice cannot be cancelled"}},"security":[{"bearer":[]}],"summary":"Cancel an invoice","tags":["Invoices"]}},"/api/v1/invoices/{id}/qrcode":{"get":{"operationId":"getQRCode","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"QR code generated successfully"},"404":{"description":"Invoice not found"}},"security":[{"bearer":[]}],"summary":"Get QR code for invoice","tags":["Invoices"]}},"/api/v1/discounts":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDiscountDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a discount (coupon or automatic offer)","tags":["discounts"]},"get":{"operationId":"list","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"mode","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List discounts for a project","tags":["discounts"]}},"/api/v1/discounts/{id}":{"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDiscountDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update a discount","tags":["discounts"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a discount","tags":["discounts"]}},"/api/v1/discounts/validate":{"post":{"operationId":"validate","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateCouponDto"}}}},"responses":{"201":{"description":""}},"summary":"Validate a coupon code for a project + amount (public checkout)","tags":["discounts"]}},"/api/v1/discounts/offer":{"post":{"operationId":"resolveOffer","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveOfferDto"}}}},"responses":{"201":{"description":""}},"summary":"Resolve the auto-applied offer for a project + amount (public)","tags":["discounts"]}},"/api/v1/refunds/invoice/{invoiceId}":{"post":{"description":"Lightning has no chargebacks — refunds are merchant-initiated. type=credit records a note (settle off-band); type=payment sends sats back to the customer bolt11/lightning address. Partial refunds supported while total refunded ≤ invoice amount.","operationId":"create","parameters":[{"name":"invoiceId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRefundDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a refund for a paid invoice","tags":["Refunds"]},"get":{"operationId":"listForInvoice","parameters":[{"name":"invoiceId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List refunds for an invoice","tags":["Refunds"]}},"/api/v1/refunds":{"get":{"operationId":"listAll","parameters":[{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"offset","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List all refunds (merchant)","tags":["Refunds"]}},"/api/v1/payments":{"get":{"operationId":"findAll","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"enum":["pending","completed","failed"],"type":"string"}},{"name":"type","required":false,"in":"query","schema":{"enum":["incoming","outgoing"],"type":"string"}},{"name":"label","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payments retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all payments","tags":["Payments"]}},"/api/v1/payments/stats/daily":{"get":{"description":"Income/spend/fee/count per UTC day for the last N days (default 30, max 365). LNbits-style aggregation for dashboard charts.","operationId":"getDailyStats","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"days","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Daily payment statistics","tags":["Payments"]}},"/api/v1/payments/stats/count":{"get":{"description":"Group payments by status, project, type or label (LNbits stats/count equivalent).","operationId":"getCountStats","parameters":[{"name":"by","required":true,"in":"query","schema":{"enum":["status","project","type","label"],"type":"string"}},{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Payment totals grouped by a dimension","tags":["Payments"]}},"/api/v1/payments/labels":{"get":{"operationId":"listLabels","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"All payment labels in use (for autocomplete)","tags":["Payments"]}},"/api/v1/payments/export/csv":{"get":{"description":"Downloads ALL payments matching the filters (no pagination limit) as a CSV file — for accounting/reconciliation.","operationId":"exportCsv","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"enum":["pending","completed","failed"],"type":"string"}},{"name":"type","required":false,"in":"query","schema":{"enum":["incoming","outgoing"],"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"CSV file download","content":{"text/csv":{}}}},"security":[{"bearer":[]}],"summary":"Export payments as CSV","tags":["Payments"]}},"/api/v1/payments/stats":{"get":{"operationId":"getStats","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Statistics retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get payment statistics","tags":["Payments"]}},"/api/v1/payments/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payment retrieved successfully"},"404":{"description":"Payment not found"}},"security":[{"bearer":[]}],"summary":"Get a single payment","tags":["Payments"]}},"/api/v1/payments/{paymentHash}/labels":{"put":{"description":"Replace the payment labels (max 10, 50 chars each, lowercased). LNbits-compatible endpoint for accounting/reconciliation workflows.","operationId":"updateLabels","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Labels updated"},"404":{"description":"Payment not found"}},"security":[{"bearer":[]}],"summary":"Update payment labels","tags":["Payments"]}},"/api/v1/webhooks":{"post":{"description":"Creates a new webhook. The secret is only shown ONCE - save it securely! Requires webhooks:write scope when using an API key.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookDto"}}}},"responses":{"201":{"description":"Webhook created successfully. Secret is returned only once."}},"security":[{"bearer":[]}],"summary":"Create a new webhook endpoint","tags":["Webhooks"]},"get":{"operationId":"findAll","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Webhooks retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all webhooks","tags":["Webhooks"]}},"/api/v1/webhooks/deliveries":{"get":{"operationId":"findDeliveries","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"enum":["success","failed","pending"],"type":"string"}},{"name":"event","required":false,"in":"query","schema":{"type":"string"}},{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"webhookId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List webhook deliveries (retry dashboard)","tags":["Webhooks"]}},"/api/v1/webhooks/deliveries/stats":{"get":{"operationId":"deliveryStats","parameters":[{"name":"webhookId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delivery status counts for dashboard stat cards","tags":["Webhooks"]}},"/api/v1/webhooks/deliveries/export/csv":{"get":{"description":"Downloads up to 10,000 delivery attempts matching the filters as a CSV file.","operationId":"exportDeliveriesCsv","parameters":[{"name":"status","required":false,"in":"query","schema":{"enum":["success","failed","pending"],"type":"string"}},{"name":"event","required":false,"in":"query","schema":{"type":"string"}},{"name":"webhookId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"CSV file download","content":{"text/csv":{}}}},"security":[{"bearer":[]}],"summary":"Export webhook deliveries as CSV","tags":["Webhooks"]}},"/api/v1/webhooks/deliveries/{id}":{"get":{"operationId":"findDelivery","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"404":{"description":"Delivery not found"}},"security":[{"bearer":[]}],"summary":"Get a single delivery (full payload + error)","tags":["Webhooks"]}},"/api/v1/webhooks/deliveries/{id}/retry":{"post":{"description":"Re-delivers the exact stored payload to the original endpoint with a fresh attempt counter.","operationId":"retryDelivery","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"400":{"description":"Delivery is still in progress"}},"security":[{"bearer":[]}],"summary":"Manually retry a delivery","tags":["Webhooks"]}},"/api/v1/webhooks/events/{eventId}/replay":{"post":{"description":"Re-delivers the stored event byte-identically (same evt_ id) to every endpoint that originally received it. Consumers can dedup on the event id.","operationId":"replayEvent","parameters":[{"name":"eventId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"404":{"description":"No deliveries found for this event"}},"security":[{"bearer":[]}],"summary":"Replay an event to all subscribed endpoints","tags":["Webhooks"]}},"/api/v1/webhooks/{id}/test":{"post":{"operationId":"testWebhook","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Test webhook sent"}},"security":[{"bearer":[]}],"summary":"Test webhook delivery","tags":["Webhooks"]}},"/api/v1/webhooks/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Webhook retrieved successfully"},"404":{"description":"Webhook not found"}},"security":[{"bearer":[]}],"summary":"Get a single webhook","tags":["Webhooks"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Webhook deleted successfully"},"404":{"description":"Webhook not found"}},"security":[{"bearer":[]}],"summary":"Delete a webhook","tags":["Webhooks"]}},"/api/v1/webhooks/{id}/secret":{"get":{"description":"Returns the webhook signing secret (for verifying deliveries with the SDK). Owner-only; the secret is select:false everywhere else.","operationId":"revealSecret","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"The signing secret"}},"security":[{"bearer":[]}],"summary":"Reveal the webhook signing secret","tags":["Webhooks"]}},"/api/v1/webhooks/{id}/roll-secret":{"post":{"description":"Generates a NEW secret and invalidates the old one immediately. Update your server with the new secret — deliveries after rotation are signed with it.","operationId":"rollSecret","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Roll (rotate) the webhook signing secret","tags":["Webhooks"]}},"/api/v1/webhooks/{id}/status":{"patch":{"operationId":"updateStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Webhook status updated successfully"}},"security":[{"bearer":[]}],"summary":"Update webhook status","tags":["Webhooks"]}},"/api/v1/creator-plans":{"get":{"operationId":"listPlans","parameters":[{"name":"includeInactive","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my subscription plans","tags":["creator-plans"]},"post":{"operationId":"createPlan","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlanDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a plan","tags":["creator-plans"]}},"/api/v1/creator-plans/{id}":{"patch":{"operationId":"updatePlan","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update a plan","tags":["creator-plans"]},"delete":{"operationId":"deletePlan","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete (or deactivate) a plan","tags":["creator-plans"]}},"/api/v1/creator-plans/subscriptions":{"get":{"operationId":"listSubscribers","parameters":[{"name":"planId","required":true,"in":"query","schema":{"type":"string"}},{"name":"status","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my subscribers","tags":["creator-plans"]}},"/api/v1/creator-plans/revenue":{"get":{"operationId":"getRevenue","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"MRR/ARR stats","tags":["creator-plans"]}},"/api/v1/creator-plans/my-subscriptions":{"get":{"operationId":"listMySubscriptions","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Subscriptions I made to creators (subscriber dashboard)","tags":["creator-plans"]}},"/api/v1/creator-plans/subscriptions/{id}/cancel":{"post":{"operationId":"cancelSubscriber","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel a subscriber (creator action)","tags":["creator-plans"]}},"/api/v1/subscribe/plans/{id}":{"get":{"operationId":"getPublicPlan","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Public plan detail (checkout page)","tags":["subscribe"]}},"/api/v1/subscribe/plans/{id}/subscribe":{"post":{"operationId":"subscribe","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeDto"}}}},"responses":{"201":{"description":""}},"summary":"Subscribe to a plan (public checkout)","tags":["subscribe"]}},"/api/v1/subscribe/portal/{token}":{"get":{"operationId":"getPortal","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Subscriber portal (magic link)","tags":["subscribe"]}},"/api/v1/subscribe/portal/{token}/cancel":{"post":{"operationId":"cancelPortal","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Cancel via magic link","tags":["subscribe"]}},"/api/v1/subscribe/portal/{token}/pause":{"post":{"operationId":"pausePortal","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Pause renewals via magic link","tags":["subscribe"]}},"/api/v1/subscribe/portal/{token}/resume":{"post":{"operationId":"resumePortal","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Resume via magic link","tags":["subscribe"]}},"/api/v1/subscribe/portal/{token}/nwc":{"post":{"operationId":"enableNwc","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Enable NWC auto-pay (subscriber wallet connection)","tags":["subscribe"]}},"/api/v1/subscribe/portal/{token}/nwc/disable":{"post":{"operationId":"disableNwc","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Disable NWC auto-pay","tags":["subscribe"]}},"/api/v1/plans":{"post":{"description":"Creates a recurring-billing plan on a project. projectId is optional for project-scoped API keys. Checkout URL: /subscribe/:planId.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlanDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a subscription plan","tags":["plans"]},"get":{"description":"projectId → that project’s plans (optional for project-scoped keys). Omit → your creator plans.","operationId":"list","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"includeInactive","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List subscription plans","tags":["plans"]}},"/api/v1/plans/{id}":{"get":{"operationId":"get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get one plan (owner)","tags":["plans"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlanDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update a plan","tags":["plans"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a plan (deactivates instead when it has subscribers)","tags":["plans"]}},"/api/v1/plans/{id}/subscriptions":{"get":{"operationId":"subscriptions","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"status","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"offset","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Subscribers of one plan (paginated)","tags":["plans"]}},"/api/v1/subscriptions":{"get":{"description":"projectId is required for account-level keys; project-scoped keys fill it in automatically.","operationId":"list","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"planId","required":true,"in":"query","schema":{"type":"string"}},{"name":"status","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"offset","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List subscribers of a project","tags":["subscriptions"]}},"/api/v1/subscriptions/revenue":{"get":{"operationId":"revenue","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Project MRR/ARR in sats","tags":["subscriptions"]}},"/api/v1/subscriptions/{id}/cancel":{"post":{"operationId":"cancel","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel a subscription (owner action)","tags":["subscriptions"]}},"/api/v1/customers":{"get":{"operationId":"list","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List customers (search, tag, segment, sort, project filter)","tags":["customers"]}},"/api/v1/customers/stats":{"get":{"operationId":"getStats","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"CRM segment stats","tags":["customers"]}},"/api/v1/customers/leaderboard":{"get":{"operationId":"getLeaderboard","parameters":[{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Top supporters leaderboard","tags":["customers"]}},"/api/v1/customers/{id}":{"get":{"operationId":"detail","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Customer detail (payments, subscriptions, segment)","tags":["customers"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update customer (tags, notes, display name)","tags":["customers"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"mode","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"GDPR anonymize (or delete if no payments)","tags":["customers"]}},"/api/v1/customers/{id}/export":{"get":{"operationId":"export","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"GDPR data export (JSON)","tags":["customers"]}},"/api/v1/notifications":{"get":{"operationId":"list","parameters":[{"name":"page","required":false,"in":"query","schema":{"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":100,"default":20,"type":"number"}},{"name":"unread","required":false,"in":"query","description":"Only unread notifications","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my notifications (paginated)","tags":["notifications"]}},"/api/v1/notifications/unread-count":{"get":{"operationId":"unreadCount","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Unread count for the bell badge","tags":["notifications"]}},"/api/v1/notifications/read-all":{"patch":{"operationId":"markAllRead","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Mark all notifications as read","tags":["notifications"]}},"/api/v1/notifications/{id}/read":{"patch":{"operationId":"markRead","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Mark one notification as read","tags":["notifications"]}},"/api/v1/notifications/{id}":{"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a notification","tags":["notifications"]}},"/api/v1/notifications/preferences":{"get":{"operationId":"getPreferences","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my notification preferences (auto-created with defaults)","tags":["notifications"]},"patch":{"operationId":"updatePreferences","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePreferencesDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update my notification preferences","tags":["notifications"]}},"/api/v1/nwc-connections":{"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my connected NWC wallets","tags":["NWC Connections"]},"post":{"description":"Validates the URI with a live get_info round-trip before saving. The connection string is stored AES-encrypted and can be revoked any time from the wallet app.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNwcConnectionDto"}}}},"responses":{"201":{"description":"Wallet connected"},"400":{"description":"Invalid URI or wallet unreachable"}},"security":[{"bearer":[]}],"summary":"Connect a wallet via a Nostr Wallet Connect URI","tags":["NWC Connections"]}},"/api/v1/nwc-connections/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Connection detail","tags":["NWC Connections"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNwcConnectionDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Rename a connection","tags":["NWC Connections"]},"delete":{"description":"Removes the stored connection string. Also revoke the connection in your wallet app to fully close the session.","operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Disconnect a wallet","tags":["NWC Connections"]}},"/api/v1/nwc-connections/{id}/refresh":{"post":{"operationId":"refresh","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Re-test the connection and refresh cached alias/balance","tags":["NWC Connections"]}},"/api/v1/nwc-connections/{id}/pay":{"post":{"description":"Executes pay_invoice over Nostr Wallet Connect. The wallet service must be online. Returns the payment preimage as proof.","operationId":"payInvoice","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Payment sent"},"400":{"description":"Wallet unreachable or payment failed"}},"security":[{"bearer":[]}],"summary":"Pay a BOLT11 invoice from this wallet","tags":["NWC Connections"]}},"/api/v1/bio/public/{slug}":{"get":{"operationId":"getPublicPage","parameters":[{"name":"slug","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Page payload"},"404":{"description":"No such page"}},"summary":"Public bio page payload","tags":["bio-links"]}},"/api/v1/bio/click/{blockId}":{"get":{"operationId":"trackClick","parameters":[{"name":"blockId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Track block click + redirect","tags":["bio-links"]}},"/api/v1/bio/page":{"get":{"operationId":"getMyPage","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my bio page","tags":["bio-links"]},"put":{"operationId":"upsertMyPage","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertBioPageDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Create or update my bio page","tags":["bio-links"]},"delete":{"operationId":"deleteMyPage","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete my bio page","tags":["bio-links"]}},"/api/v1/bio/blocks":{"get":{"operationId":"listBlocks","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my page blocks","tags":["bio-links"]},"post":{"operationId":"createBlock","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Add a block","tags":["bio-links"]}},"/api/v1/bio/blocks/{id}":{"patch":{"operationId":"updateBlock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update a block","tags":["bio-links"]},"delete":{"operationId":"deleteBlock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a block","tags":["bio-links"]}},"/api/v1/bio/blocks/reorder":{"put":{"operationId":"reorderBlocks","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderBlocksDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Reorder blocks (ordered id list)","tags":["bio-links"]}},"/api/v1/bio/public/blocks/{blockId}/pay":{"post":{"operationId":"createOrder","parameters":[{"name":"blockId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Create paid-link order (invoice)","tags":["paid-links"]}},"/api/v1/bio/public/orders/{orderId}":{"get":{"operationId":"getOrder","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Order status (poll for payment)","tags":["paid-links"]}},"/api/v1/bio/public/unlock/{token}":{"get":{"operationId":"unlock","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Unlock purchased content","tags":["paid-links"]}},"/api/v1/bio/profiles":{"get":{"operationId":"listProfiles","parameters":[{"name":"q","required":false,"in":"query","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","schema":{"enum":["boosted","new","zaps"],"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Public bio-profile directory — boosted first, then newest","tags":["bio-links"]}},"/api/v1/bio/boost-products":{"get":{"operationId":"getBoostProducts","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Available profile boost products","tags":["bio-links"]}},"/api/v1/bio/boost":{"post":{"operationId":"createBoost","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoostProfileDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Boost my bio page (plan credit first, invoice for the rest)","tags":["bio-links"]}},"/api/v1/bio/boosts":{"get":{"operationId":"listMyBoosts","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My profile boosts","tags":["bio-links"]}},"/api/v1/bio/boost/active":{"get":{"operationId":"getActiveBoost","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Active boost for my page (null when not boosted)","tags":["bio-links"]}},"/api/v1/bio/boosts/{id}/check":{"post":{"operationId":"checkBoost","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Poll boost payment → activate","tags":["bio-links"]}},"/api/v1/billing/subscription":{"get":{"operationId":"getSubscription","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Subscription retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get current subscription","tags":["Billing"]}},"/api/v1/billing/subscription/cancel":{"post":{"operationId":"cancelSubscription","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Subscription cancelled successfully"}},"security":[{"bearer":[]}],"summary":"Cancel subscription","tags":["Billing"]}},"/api/v1/billing/plans/catalog":{"get":{"operationId":"getPlans","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"The 4 platform tiers + sats pricing + features + entitlements (public — single source of truth for pricing pages)","tags":["Plans & Billing"]}},"/api/v1/billing/billing/plan":{"get":{"operationId":"getMyPlan","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My current plan + entitlements (boost credit included)","tags":["Plans & Billing"]}},"/api/v1/billing/billing/checkout":{"post":{"operationId":"checkout","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a sats invoice for a tier (minted on the platform wallet). payNow pays from my wallet.","tags":["Plans & Billing"]}},"/api/v1/billing/billing/invoices/{id}/check":{"post":{"operationId":"checkInvoice","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Poll invoice settlement → activate/extend the plan","tags":["Plans & Billing"]}},"/api/v1/billing/billing/invoices":{"get":{"operationId":"listInvoices","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My subscription payment history","tags":["Plans & Billing"]}},"/api/v1/billing/billing/cancel":{"post":{"operationId":"cancel","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel renewal — the tier stays until the paid period ends","tags":["Plans & Billing"]}},"/api/v1/admin/plans/users":{"get":{"operationId":"listUsers","parameters":[{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"tier","required":false,"in":"query","schema":{"enum":["free","zap","pro","business"],"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Users + their plans (search, filter by tier)","tags":["Admin Plans"]}},"/api/v1/admin/plans/users/{userId}":{"get":{"operationId":"getUser","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One user: plan + merged entitlements + invoice history","tags":["Admin Plans"]}},"/api/v1/admin/plans/users/{userId}/tier":{"patch":{"operationId":"setTier","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSetTierDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Set a user's tier manually (gift/comp/downgrade, no payment)","tags":["Admin Plans"]}},"/api/v1/admin/plans/users/{userId}/extend":{"post":{"operationId":"extend","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminExtendPeriodDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Extend (negative: shorten) the current paid period","tags":["Admin Plans"]}},"/api/v1/admin/plans/users/{userId}/overrides":{"patch":{"operationId":"setOverrides","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminOverridesDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Set/merge per-user entitlement overrides — increase/decrease any quota (null clears a key)","tags":["Admin Plans"]},"delete":{"operationId":"clearOverrides","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Clear ALL overrides — back to pure tier defaults","tags":["Admin Plans"]}},"/api/v1/admin/plans/users/{userId}/boost-credit":{"post":{"operationId":"grantBoostCredit","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBoostCreditDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Grant extra free-boost credit this period","tags":["Admin Plans"]}},"/api/v1/splits/rules":{"get":{"operationId":"getRule","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get the split rule for a project","tags":["Splits"]},"put":{"description":"Targets are lightning addresses with a percent each (sum ≤ 100%). Every settled project invoice pays out the shares automatically; the remainder stays with you.","operationId":"upsertRule","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Rule saved"}},"security":[{"bearer":[]}],"summary":"Create or replace the split rule for a project","tags":["Splits"]},"delete":{"operationId":"deleteRule","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete the split rule for a project","tags":["Splits"]}},"/api/v1/splits/executions":{"get":{"operationId":"listExecutions","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Split payout history for a project","tags":["Splits"]}},"/api/v1/gift-cards":{"post":{"operationId":"issue","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGiftCardDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Issue a gift card (paid = purchase invoice, free = merchant-funded)","tags":["gift-cards"]},"get":{"operationId":"list","parameters":[{"name":"projectId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my gift cards","tags":["gift-cards"]}},"/api/v1/gift-cards/{id}":{"get":{"operationId":"detail","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Gift card detail (with redemption history)","tags":["gift-cards"]}},"/api/v1/gift-cards/{id}/disable":{"post":{"operationId":"disable","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Disable a gift card (stop further redemptions)","tags":["gift-cards"]}},"/api/v1/gift-cards/public/{code}":{"get":{"operationId":"getPublic","parameters":[{"name":"code","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Check a gift card by code (balance, status, redeem LNURL)","tags":["gift-cards"]}},"/api/v1/gift-cards/public/{code}/check-purchase":{"post":{"operationId":"checkPurchase","parameters":[{"name":"code","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Poll a paid card’s purchase settlement (activates on payment)","tags":["gift-cards"]}},"/api/v1/gift-cards/public/{code}/redeem":{"post":{"operationId":"redeem","parameters":[{"name":"code","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedeemGiftCardDto"}}}},"responses":{"201":{"description":""}},"summary":"Redeem from a gift card — returns the LNURL-withdraw the recipient claims into their own wallet","tags":["gift-cards"]}},"/api/v1/my-wallet/withdrawals":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWithdrawalDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Withdraw sats (BOLT11 / lightning address / LNURL)","tags":["withdrawals"]},"get":{"operationId":"findAll","parameters":[{"name":"limit","required":true,"in":"query","schema":{"type":"string"}},{"name":"offset","required":true,"in":"query","schema":{"type":"string"}},{"name":"status","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Withdrawal history","tags":["withdrawals"]}},"/api/v1/my-wallet/withdrawals/limits":{"get":{"operationId":"getLimits","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Current velocity-limit usage","tags":["withdrawals"]}},"/api/v1/my-wallet/withdrawals/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Withdrawal detail (incl. preimage proof)","tags":["withdrawals"]}},"/api/v1/my-wallet/withdraw-links":{"post":{"description":"Creates a scannable voucher: anyone with the LNURL/QR can pull the fixed amount from your wallet, up to `uses` times. Sats stay in your wallet until actually claimed.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Link created"},"400":{"description":"Invalid params, insufficient balance, or link limit reached"}},"security":[{"bearer":[]}],"summary":"Create an LNURL-withdraw link","tags":["LNURL Withdraw Links"]},"get":{"operationId":"findAll","parameters":[{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my withdraw links","tags":["LNURL Withdraw Links"]}},"/api/v1/my-wallet/withdraw-links/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"404":{"description":"Link not found"}},"security":[{"bearer":[]}],"summary":"Withdraw link detail (current used count)","tags":["LNURL Withdraw Links"]},"delete":{"description":"Unclaimed sats stay in the wallet.","operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"404":{"description":"Link not found"}},"security":[{"bearer":[]}],"summary":"Delete a withdraw link","tags":["LNURL Withdraw Links"]}},"/api/v1/payment-links":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentLinkDto"}}}},"responses":{"201":{"description":"Payment link created successfully"}},"security":[{"bearer":[]}],"summary":"Create a new payment link (creates real LNURL-pay link on LNbits)","tags":["Payment Links"]},"get":{"operationId":"findAll","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"isQuickLink","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payment links retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get all payment links","tags":["Payment Links"]}},"/api/v1/payment-links/public/{shortId}":{"get":{"operationId":"findByShortId","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payment link retrieved successfully"},"404":{"description":"Payment link not found"}},"summary":"Get payment link by short ID (public access)","tags":["Payment Links"]}},"/api/v1/payment-links/public/{shortId}/lnurl":{"get":{"operationId":"getLnurlParams","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Get LNURL-pay params for a payment link (public)","tags":["Payment Links"]}},"/api/v1/payment-links/public/{shortId}/invoice":{"post":{"operationId":"requestInvoice","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"Request an invoice for a payment link (public) — offers auto-apply; couponCode optional","tags":["Payment Links"]}},"/api/v1/payment-links/public/{shortId}/verify":{"get":{"operationId":"checkInvoiceStatus","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"url","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Check invoice payment status via verify URL (public)","tags":["Payment Links"]}},"/api/v1/payment-links/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payment link retrieved successfully"},"404":{"description":"Payment link not found"}},"security":[{"bearer":[]}],"summary":"Get a single payment link","tags":["Payment Links"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payment link deleted successfully"},"404":{"description":"Payment link not found"}},"security":[{"bearer":[]}],"summary":"Delete a payment link (also deletes LNURL-pay link on LNbits)","tags":["Payment Links"]}},"/api/v1/payment-links/{id}/status":{"patch":{"operationId":"updateStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Payment link status updated successfully"}},"security":[{"bearer":[]}],"summary":"Update payment link status","tags":["Payment Links"]}},"/api/v1/payment-links/{id}/qrcode":{"get":{"operationId":"getQRCode","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"QR code generated successfully"},"404":{"description":"Payment link not found"}},"security":[{"bearer":[]}],"summary":"Get QR code for payment link","tags":["Payment Links"]}},"/api/v1/wallet/info":{"get":{"operationId":"getWalletInfo","parameters":[{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Wallet info retrieved"}},"security":[{"bearer":[]}],"summary":"Get wallet info and balance","tags":["Wallet"]}},"/api/v1/wallet/wallets":{"get":{"operationId":"getWallets","parameters":[{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List all wallets of the user","tags":["Wallet"]},"post":{"operationId":"createWallet","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a new wallet","tags":["Wallet"]}},"/api/v1/wallet/accounts":{"post":{"operationId":"createAccount","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a new account (user + wallet) for other users","tags":["Wallet"]}},"/api/v1/wallet/payments":{"get":{"operationId":"getPayments","parameters":[{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get wallet payments","tags":["Wallet"]}},"/api/v1/wallet/payments/history":{"get":{"operationId":"getPaymentsHistory","parameters":[{"name":"group","required":false,"in":"query","schema":{"enum":["hour","day","month"],"type":"string"}},{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get payments history for charts","tags":["Wallet"]}},"/api/v1/wallet/payments/{paymentHash}/status":{"get":{"operationId":"checkPaymentStatus","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check payment status","tags":["Wallet"]}},"/api/v1/wallet/invoices":{"post":{"operationId":"createInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create invoice (receive sats)","tags":["Wallet"]}},"/api/v1/wallet/pay":{"post":{"operationId":"payInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay a BOLT11 invoice (send sats)","tags":["Wallet"]}},"/api/v1/wallet/pay/lnurl":{"post":{"operationId":"payLnurl","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay an LNURL or lightning address","tags":["Wallet"]}},"/api/v1/wallet/lnurl/scan":{"post":{"operationId":"lnurlScan","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Scan/decode an LNURL or lightning address","tags":["Wallet"]}},"/api/v1/wallet/decode":{"post":{"operationId":"decodeInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Decode a BOLT11 invoice","tags":["Wallet"]}},"/api/v1/wallet/rates/{currency}":{"get":{"operationId":"getExchangeRate","parameters":[{"name":"currency","required":true,"in":"path","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get exchange rate for a currency","tags":["Wallet"]}},"/api/v1/wallet/convert":{"post":{"operationId":"convert","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Convert fiat to sats or vice versa","tags":["Wallet"]}},"/api/v1/wallet/currencies":{"get":{"operationId":"getCurrencies","parameters":[{"name":"providerId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List available currencies","tags":["Wallet"]}},"/api/v1/wallet/qrcode":{"get":{"operationId":"generateQRCode","parameters":[{"name":"data","required":true,"in":"query","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Generate QR code for arbitrary data","tags":["Wallet"]}},"/api/v1/my-wallet/overview":{"get":{"operationId":"getOverview","parameters":[{"name":"walletId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Aggregated wallet dashboard: info + payments + history + links + withdrawals + lndhub in ONE call (10s cache)","tags":["My Wallet"]}},"/api/v1/lndhub/credentials":{"get":{"operationId":"status","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"LNDHub status for my wallet","tags":["lndhub"]},"post":{"description":"Generates the lndhub:// connection URI for BlueWallet/Zeus. Rotating invalidates the old password.","operationId":"enable","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Enable (or rotate) LNDHub — returns the password ONCE","tags":["lndhub"]},"delete":{"operationId":"disable","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Disable LNDHub access","tags":["lndhub"]}},"/api/v1/lndhub/ext/getinfo":{"get":{"operationId":"getInfo","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Public LNDHub info (alias/version)","tags":["lndhub"]}},"/api/v1/lndhub/ext/auth":{"post":{"operationId":"auth","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"summary":"LNDHub auth — exchange login/password (or refresh_token) for tokens","tags":["lndhub"]}},"/api/v1/lndhub/ext/balance":{"get":{"operationId":"getBalance","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Wallet balance (sats)","tags":["lndhub"]}},"/api/v1/lndhub/ext/addinvoice":{"post":{"operationId":"addInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create invoice","tags":["lndhub"]}},"/api/v1/lndhub/ext/payinvoice":{"post":{"operationId":"payInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay a BOLT11 invoice","tags":["lndhub"]}},"/api/v1/lndhub/ext/gettxs":{"get":{"operationId":"getTxs","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Outgoing payments (sends)","tags":["lndhub"]}},"/api/v1/lndhub/ext/getuserinvoices":{"get":{"operationId":"getUserInvoices","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Incoming invoices (receives)","tags":["lndhub"]}},"/api/v1/lndhub/ext/getbtc":{"get":{"operationId":"getBtc","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"On-chain deposit address (unsupported — Lightning only)","tags":["lndhub"]}},"/api/v1/lndhub/ext/getpending":{"get":{"operationId":"getPending","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Pending on-chain transactions (unsupported)","tags":["lndhub"]}},"/api/v1/lndhub/ext/decodeinvoice":{"get":{"operationId":"decodeInvoice","parameters":[{"name":"invoice","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Decode a payment request","tags":["lndhub"]}},"/api/v1/lndhub/ext/checkrouteinvoice":{"get":{"operationId":"checkRouteInvoice","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Route check (not implemented, same as canonical)","tags":["lndhub"]}},"/api/v1/lightning-address/domains":{"get":{"operationId":"getDomains","parameters":[{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Domains retrieved"}},"security":[{"bearer":[]}],"summary":"List available NIP-5 domains","tags":["Lightning Addresses"]}},"/api/v1/lightning-address/search":{"get":{"operationId":"searchIdentifier","parameters":[{"name":"domainId","required":true,"in":"query","schema":{"type":"string"}},{"name":"identifier","required":true,"in":"query","schema":{"type":"string"}},{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Search identifier availability on a domain","tags":["Lightning Addresses"]}},"/api/v1/lightning-address":{"post":{"operationId":"register","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Lightning address registered"},"409":{"description":"Address already taken"}},"security":[{"bearer":[]}],"summary":"Register a lightning address","tags":["Lightning Addresses"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my lightning addresses","tags":["Lightning Addresses"]}},"/api/v1/lightning-address/sync":{"get":{"operationId":"sync","parameters":[{"name":"providerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Sync addresses from LNbits","tags":["Lightning Addresses"]}},"/api/v1/lightning-address/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get a lightning address","tags":["Lightning Addresses"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a lightning address","tags":["Lightning Addresses"]}},"/api/v1/lightning-address/{id}/qrcode":{"get":{"operationId":"getQRCode","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get QR code for a lightning address","tags":["Lightning Addresses"]}},"/api/v1/lightning-address/{id}/toggle":{"patch":{"operationId":"toggleActive","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Toggle lightning address active state","tags":["Lightning Addresses"]}},"/api/v1/lightning-address/{id}/wallet":{"patch":{"description":"Set `providerId` to receive on a connected external LNbits provider (BYO wallet), `accountWalletId` to receive on a specific account wallet, or neither to reset to the default platform-provisioned wallet. Only one of the two may be set. Ownership of both the address and the target wallet/provider is verified.","operationId":"linkWallet","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkWalletDto"}}}},"responses":{"200":{"description":"Wallet link updated."}},"security":[{"bearer":[]}],"summary":"Link address to the wallet that receives its payments","tags":["Lightning Addresses"]}},"/api/v1/lnurl/params/{username}":{"get":{"operationId":"getPayParams","parameters":[{"name":"username","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-served-domain","required":true,"in":"header","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"LNURL-pay params for a lightning address","tags":["lnurl"]}},"/api/v1/lnurl/callback/{username}":{"get":{"operationId":"handleCallback","parameters":[{"name":"username","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-served-domain","required":true,"in":"header","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"LNURL-pay callback — issue BOLT11 invoice","tags":["lnurl"]}},"/api/v1/lnurl/verify/{paymentHash}":{"get":{"operationId":"verifyPayment","parameters":[{"name":"paymentHash","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"LUD-21 payment verification","tags":["lnurl"]}},"/api/v1/lnurl/nip05":{"get":{"operationId":"getNip05","parameters":[{"name":"name","required":true,"in":"query","schema":{"type":"string"}},{"name":"x-served-domain","required":true,"in":"header","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"NIP-05 nostr identity lookup","tags":["lnurl"]}},"/api/v1/lnurl/availability/{username}":{"get":{"description":"First-party domains only (zapapi.app + SERVED_DOMAINS). For marketplace domains use GET /marketplace/search — it fans out live to each domain provider.","operationId":"checkAvailability","parameters":[{"name":"username","required":true,"in":"path","schema":{"type":"string"}},{"name":"domain","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Check lightning address username availability","tags":["lnurl"]}},"/api/v1/lnurl/claim":{"post":{"operationId":"claim","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimAddressDto"}}}},"responses":{"201":{"description":"Address claimed"},"409":{"description":"Username taken or reserved"}},"security":[{"bearer":[]}],"summary":"Claim your name@domain lightning address (free)","tags":["lnurl"]},"get":{"operationId":"getMyClaim","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get my claimed lightning address","tags":["lnurl"]},"patch":{"operationId":"updateClaim","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClaimedAddressDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Update my claimed address (pubkey, relays)","tags":["lnurl"]},"delete":{"operationId":"releaseClaim","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Release my claimed address","tags":["lnurl"]}},"/api/v1/lnurl/claim/pubkey-challenge":{"post":{"description":"Sign a kind 27235 event with tags [[\"challenge\", c]] and pass it as pubkeyProof when claiming or updating the pubkey.","operationId":"pubkeyChallenge","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Get a challenge to prove nostr pubkey ownership (NIP-05)","tags":["lnurl"]}},"/api/v1/nwc/connections":{"get":{"operationId":"list","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my NWC connections","tags":["NWC"]},"post":{"description":"Generates a nostr+walletconnect:// URI with per-connection permissions, budget (sats + period) and optional expiry. The client secret is never shown again.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Connection created"}},"security":[{"bearer":[]}],"summary":"Create a NWC connection — URI shown ONCE","tags":["NWC"]}},"/api/v1/nwc/connections/{id}":{"delete":{"operationId":"revoke","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"404":{"description":"Connection not found"}},"security":[{"bearer":[]}],"summary":"Revoke a connection","tags":["NWC"]}},"/api/v1/paywalls/public/{shortId}":{"get":{"operationId":"getPublicView","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public paywall view (title, price — no destination)","tags":["Paywalls"]}},"/api/v1/paywalls/public/{shortId}/invoice":{"post":{"operationId":"createInvoice","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Issue an invoice for this paywall (public)","tags":["Paywalls"]}},"/api/v1/paywalls/public/{shortId}/access":{"get":{"operationId":"checkAccess","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"paymentHash","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check access — reveals the destination when the invoice is paid","tags":["Paywalls"]}},"/api/v1/paywalls":{"post":{"description":"Protect a URL behind a Lightning payment. Payers see title + price; the destination is revealed only after payment.","operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Paywall created"}},"security":[{"bearer":[]}],"summary":"Create a paywall","tags":["Paywalls"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my paywalls","tags":["Paywalls"]}},"/api/v1/paywalls/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Paywall detail (incl. destination — owner only)","tags":["Paywalls"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a paywall","tags":["Paywalls"]}},"/api/v1/paywalls/{id}/status":{"patch":{"operationId":"updateStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Enable or disable a paywall","tags":["Paywalls"]}},"/api/v1/relay-passes/public/{shortId}":{"get":{"operationId":"getPublicView","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public pass view (title, price, relay)","tags":["Relay Passes"]}},"/api/v1/relay-passes/public/{shortId}/invoice":{"post":{"operationId":"createInvoice","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Issue an invoice for a buyer pubkey (public)","tags":["Relay Passes"]}},"/api/v1/relay-passes/public/{shortId}/grant":{"get":{"operationId":"checkGrant","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"paymentHash","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Buyer checks if their payment settled","tags":["Relay Passes"]}},"/api/v1/relay-passes/public/{shortId}/access/{pubkey}":{"get":{"operationId":"checkAccess","parameters":[{"name":"shortId","required":true,"in":"path","schema":{"type":"string"}},{"name":"pubkey","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Relay allowlist check — is this pubkey a current member? (called by relay auth plugins)","tags":["Relay Passes"]}},"/api/v1/relay-passes":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Create a relay access pass","tags":["Relay Passes"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my relay passes","tags":["Relay Passes"]}},"/api/v1/relay-passes/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Relay pass detail","tags":["Relay Passes"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a relay pass","tags":["Relay Passes"]}},"/api/v1/relay-passes/{id}/grants":{"get":{"operationId":"listGrants","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Recent buyer grants for this pass","tags":["Relay Passes"]}},"/api/v1/relay-passes/{id}/status":{"patch":{"operationId":"updateStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Enable/disable a relay pass","tags":["Relay Passes"]}},"/api/v1/events/public/{id}":{"get":{"operationId":"getPublicView","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public event view (name, price, availability)","tags":["Events"]}},"/api/v1/events/public/{id}/tickets":{"post":{"operationId":"buyTicket","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Buy a ticket (public)","tags":["Events"]}},"/api/v1/events/public/tickets/{ticketId}":{"get":{"operationId":"getTicket","parameters":[{"name":"ticketId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Buyer ticket view — reveals the check-in QR code once paid","tags":["Events"]}},"/api/v1/events":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Event created"}},"security":[{"bearer":[]}],"summary":"Create an event with paid tickets","tags":["Events"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my events","tags":["Events"]}},"/api/v1/events/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Event detail (owner)","tags":["Events"]}},"/api/v1/events/{id}/cancel":{"patch":{"operationId":"cancel","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel an event (stops ticket sales)","tags":["Events"]}},"/api/v1/events/{id}/tickets":{"get":{"operationId":"listTickets","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List tickets for an event (owner)","tags":["Events"]}},"/api/v1/events/{id}/check-in":{"put":{"description":"Scan the buyer ticket QR (checkCode) at the door. Returns checked-in, already, unpaid or invalid.","operationId":"checkIn","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"code","required":true,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check in a ticket by QR code","tags":["Events"]}},"/api/v1/calendar/public/schedules/{id}":{"get":{"operationId":"getPublicView","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public schedule view with availability","tags":["Calendar"]}},"/api/v1/calendar/public/schedules/{id}/book":{"post":{"operationId":"book","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Book a slot (public)","tags":["Calendar"]}},"/api/v1/calendar/public/appointments/{id}":{"get":{"operationId":"checkAppointment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Appointment confirmation check (public)","tags":["Calendar"]}},"/api/v1/calendar/schedules":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Schedule created"}},"security":[{"bearer":[]}],"summary":"Create a paid schedule","tags":["Calendar"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my schedules","tags":["Calendar"]}},"/api/v1/calendar/schedules/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Schedule detail (owner)","tags":["Calendar"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a schedule","tags":["Calendar"]}},"/api/v1/calendar/schedules/{id}/status":{"patch":{"operationId":"updateStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Enable or disable a schedule","tags":["Calendar"]}},"/api/v1/calendar/schedules/{id}/appointments":{"get":{"operationId":"listAppointments","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Appointments for a schedule (owner)","tags":["Calendar"]}},"/api/v1/calendar/schedules/{id}/unavailable":{"post":{"operationId":"blockTime","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Block a period (vacation, conflicts)","tags":["Calendar"]}},"/api/v1/calendar/schedules/{id}/unavailable/{blockedId}":{"delete":{"operationId":"unblockTime","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"blockedId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Unblock a period","tags":["Calendar"]}},"/api/v1/tabs/public/{id}":{"get":{"operationId":"getPublicView","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public tab view — balance + recent entries","tags":["Tabs"]}},"/api/v1/tabs/public/{id}/settle":{"post":{"operationId":"createSettlement","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay (part of) the tab balance (public)","tags":["Tabs"]}},"/api/v1/tabs/public/settlements/{settlementId}":{"get":{"operationId":"checkSettlement","parameters":[{"name":"settlementId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Settlement confirmation check (public)","tags":["Tabs"]}},"/api/v1/tabs":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Tab created"}},"security":[{"bearer":[]}],"summary":"Open a tab","tags":["Tabs"]},"get":{"operationId":"findAll","parameters":[{"name":"includeArchived","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my tabs","tags":["Tabs"]}},"/api/v1/tabs/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Tab detail (owner)","tags":["Tabs"]}},"/api/v1/tabs/{id}/status":{"patch":{"operationId":"updateStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Close or reopen a tab","tags":["Tabs"]}},"/api/v1/tabs/{id}/archive":{"patch":{"operationId":"archive","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Archive a tab","tags":["Tabs"]}},"/api/v1/tabs/{id}/entries":{"get":{"operationId":"listEntries","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Tab entries (owner)","tags":["Tabs"]},"post":{"description":"Charge increases the balance; credit decreases it (comp, correction). Enforces the tab limit when set.","operationId":"addEntry","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Add a charge or credit to the tab","tags":["Tabs"]}},"/api/v1/tabs/{id}/settlements":{"get":{"operationId":"listSettlements","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Tab settlements (owner)","tags":["Tabs"]}},"/api/v1/tabs/{id}/settlements/{settlementId}":{"delete":{"operationId":"cancelSettlement","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"settlementId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel a pending settlement","tags":["Tabs"]}},"/api/v1/swaps/info":{"get":{"description":"Boltz reachability + current min/max sats and fee structure for both directions.","operationId":"getInfo","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Swap availability, limits and fees","tags":["Swaps"]}},"/api/v1/swaps":{"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my swaps","tags":["Swaps"]}},"/api/v1/swaps/submarine":{"post":{"description":"Creates a Boltz swap and pays its invoice from your wallet. Boltz sends on-chain; track progress via the status endpoint. Set BOLTZ_ENABLED=false to disable platform-wide.","operationId":"createSubmarine","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Swap created + invoice paid"},"400":{"description":"Invalid address, out of limits, or payment failed"}},"security":[{"bearer":[]}],"summary":"Submarine swap — withdraw sats to a Bitcoin address","tags":["Swaps"]}},"/api/v1/swaps/reverse":{"post":{"description":"Returns a lockup address + BIP21. Send on-chain BTC there; Boltz pays your wallet on confirmation.","operationId":"createReverse","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Lockup address returned"}},"security":[{"bearer":[]}],"summary":"Reverse swap — deposit on-chain BTC into your wallet","tags":["Swaps"]}},"/api/v1/swaps/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Swap detail","tags":["Swaps"]}},"/api/v1/swaps/{id}/refresh":{"post":{"description":"Maps Boltz lifecycle (invoice.paid → transaction.mempool → confirmed → done) onto the swap record.","operationId":"refresh","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Poll the Boltz status and update the swap","tags":["Swaps"]}},"/api/v1/watchonly/wallets":{"post":{"description":"Parses + validates the xpub (xpub/ypub/zpub, or tpub/upub/vpub on testnet), stores it encrypted, and derives the first receive addresses. Zero private key material.","operationId":"importXpub","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":"Wallet imported"}},"security":[{"bearer":[]}],"summary":"Import an xpub (watch-only wallet)","tags":["Watch-Only"]},"get":{"operationId":"findAll","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List my watch-only wallets","tags":["Watch-Only"]}},"/api/v1/watchonly/wallets/{id}":{"get":{"operationId":"findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Wallet detail","tags":["Watch-Only"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a watch-only wallet","tags":["Watch-Only"]}},"/api/v1/watchonly/wallets/{id}/addresses":{"get":{"operationId":"listAddresses","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List derived addresses (with balances)","tags":["Watch-Only"]}},"/api/v1/watchonly/wallets/{id}/addresses/fresh":{"post":{"operationId":"freshAddress","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"note","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Fresh receive address (reuses the newest unused one, else derives next)","tags":["Watch-Only"]}},"/api/v1/watchonly/wallets/{id}/refresh":{"post":{"description":"Best-effort: updates every address + the cached wallet total.","operationId":"refreshBalances","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Refresh balances from mempool.space","tags":["Watch-Only"]}},"/api/v1/watchonly/wallets/{id}/psbt":{"post":{"description":"Gathers confirmed UTXOs across the wallet, builds a BIP-174 PSBT with witness_utxo per input for external signing (Sparrow, Coldcard, Ledger). Change returns to a fresh address.","operationId":"buildPsbt","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Build a PSBT spending to a destination (p2wpkh wallets)","tags":["Watch-Only"]}},"/api/v1/marketplace/providers":{"get":{"operationId":"getProviders","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Public provider catalog (active providers + their domains)","tags":["Marketplace"]}},"/api/v1/marketplace/search":{"get":{"operationId":"search","parameters":[{"name":"q","required":true,"in":"query","description":"Name to look up across all providers","schema":{"type":"string","examples":["alice"]}},{"name":"years","required":false,"in":"query","description":"Registration term in years (per-domain max applies)","schema":{"type":"number","examples":[1]}},{"name":"availableOnly","required":false,"in":"query","schema":{"type":"boolean","examples":[true]}},{"name":"sort","required":false,"in":"query","schema":{"enum":["price","domain"],"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Aggregated address search — one query fanned out to every active provider (free first-party first, then cheapest)","tags":["Marketplace"]}},"/api/v1/marketplace/providers/apply":{"post":{"operationId":"apply","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyProviderDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Apply to list your LNbits nostrnip5 domains — instant health-check, then pending admin review","tags":["Marketplace"]}},"/api/v1/marketplace/my-providers":{"get":{"operationId":"myProviders","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My provider applications and their review status","tags":["Marketplace"]}},"/api/v1/marketplace/my-providers/{id}/stats":{"get":{"operationId":"myProviderStats","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Provider dashboard: my domains + sales receipts (payouts went straight to my domain wallet at purchase time)","tags":["Marketplace"]}},"/api/v1/admin/marketplace/providers":{"post":{"operationId":"register","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterProviderDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Register a provider (health-check + domain import; fails closed if unreachable)","tags":["Admin Marketplace"]},"get":{"operationId":"list","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List all providers (including paused)","tags":["Admin Marketplace"]}},"/api/v1/admin/marketplace/providers/{id}":{"get":{"operationId":"get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Provider detail","tags":["Admin Marketplace"]},"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProviderDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Pause/resume, set commission, rotate invoice key","tags":["Admin Marketplace"]},"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a provider (cascades to its domains and orders)","tags":["Admin Marketplace"]}},"/api/v1/admin/marketplace/providers/{id}/approve":{"post":{"operationId":"approve","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Approve a pending self-serve application → provider goes live","tags":["Admin Marketplace"]}},"/api/v1/admin/marketplace/providers/{id}/reject":{"post":{"operationId":"reject","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectProviderDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Reject a pending application with a reason","tags":["Admin Marketplace"]}},"/api/v1/admin/marketplace/providers/{id}/refresh":{"post":{"operationId":"refresh","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Re-import the provider domain catalog now","tags":["Admin Marketplace"]}},"/api/v1/marketplace/orders":{"post":{"operationId":"create","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMarketplaceOrderDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Reserve at the provider + return the invoice (minted on the provider domain wallet). First-party rows claim free + instantly. Returns { requote } instead when the price drifted >5% from the search quote.","tags":["Marketplace Orders"]},"get":{"operationId":"list","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My orders across all providers","tags":["Marketplace Orders"]}},"/api/v1/marketplace/orders/{id}":{"get":{"operationId":"get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Order detail","tags":["Marketplace Orders"]},"delete":{"operationId":"cancel","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Cancel a reserved (unpaid) order — local only, reservations are soft provider-side","tags":["Marketplace Orders"]}},"/api/v1/marketplace/orders/{id}/pay":{"post":{"operationId":"pay","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"walletId","required":false,"in":"query","description":"Pay from a specific account wallet (default = my default wallet)","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay the invoice from my ZapAPI wallet (payment rail — destination is the provider domain wallet). Re-checks availability first: aborts to failed if the name was taken since reservation.","tags":["Marketplace Orders"]}},"/api/v1/marketplace/orders/{id}/check":{"post":{"operationId":"check","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Poll activation at the provider. On first activation, the response includes rotationSecret exactly once — save it.","tags":["Marketplace Orders"]}},"/api/v1/marketplace/orders/{id}/publish-verification":{"post":{"operationId":"publishVerification","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishVerificationDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Publish the activated address to my nostr profile (kind 0 nip05 field) — signed with my generated key; unavailable for externally-linked keys (Phase 4)","tags":["Marketplace Orders"]}},"/api/v1/directory/apps":{"get":{"operationId":"listApps","parameters":[{"name":"category","required":false,"in":"query","schema":{"type":"string"}},{"name":"q","required":false,"in":"query","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","schema":{"enum":["score","new","zaps"],"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Browse the directory (zap-weighted + boosted ranking)","tags":["Directory"]},"post":{"operationId":"submit","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAppDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Submit an app (pending review). Omit lnAddress to auto-provision app-{slug}@zapapi.app — zaps land in your ZapAPI wallet.","tags":["Directory"]}},"/api/v1/directory/apps/{slug}":{"get":{"operationId":"getApp","parameters":[{"name":"slug","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"App detail with live score breakdown","tags":["Directory"]}},"/api/v1/directory/categories":{"get":{"operationId":"getCategories","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Directory categories","tags":["Directory"]}},"/api/v1/directory/boost-products":{"get":{"operationId":"getBoostProducts","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"summary":"Available boost products (sats × days)","tags":["Directory"]}},"/api/v1/directory/my-apps":{"get":{"operationId":"myApps","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My listings with live stats","tags":["Directory"]}},"/api/v1/directory/apps/{id}":{"patch":{"operationId":"update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Edit my listing (URL change re-triggers review)","tags":["Directory"]}},"/api/v1/directory/apps/{id}/boost":{"post":{"operationId":"boost","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoostAppDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Boost a listing: invoice on the platform wallet (ZapAPI revenue). payNow=true pays immediately from my wallet.","tags":["Directory"]}},"/api/v1/directory/boosts":{"get":{"operationId":"myBoosts","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"My boosts","tags":["Directory"]}},"/api/v1/directory/boosts/{id}/check":{"post":{"operationId":"checkBoost","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Poll boost payment → activate the boost window","tags":["Directory"]}},"/api/v1/admin/directory/apps":{"get":{"operationId":"list","parameters":[{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"All apps (optionally filtered by status)","tags":["Admin Directory"]}},"/api/v1/admin/directory/apps/{id}/approve":{"post":{"operationId":"approve","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Approve a pending listing → live in the directory","tags":["Admin Directory"]}},"/api/v1/admin/directory/apps/{id}/reject":{"post":{"operationId":"reject","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectAppDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Reject a pending listing with a reason","tags":["Admin Directory"]}},"/api/v1/admin/directory/apps/{id}/feature":{"post":{"operationId":"feature","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pin (featured) or unpin a listing","tags":["Admin Directory"]}},"/api/v1/admin/directory/apps/{id}":{"delete":{"operationId":"remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delete a listing from the directory","tags":["Admin Directory"]}},"/api/v1/usage/stats":{"get":{"operationId":"getStats","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"days","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Usage statistics retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get usage statistics","tags":["Usage"]}},"/api/v1/usage/current":{"get":{"operationId":"getCurrentUsage","parameters":[{"name":"projectId","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Current usage retrieved successfully"}},"security":[{"bearer":[]}],"summary":"Get current quota usage","tags":["Usage"]}},"/api/v1/ai/chat/completions":{"post":{"operationId":"chatCompletions","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Completion or SSE stream"},"402":{"description":"Insufficient balance"}},"security":[{"bearer":[]}],"summary":"Chat completions (OpenAI-compatible, streaming supported)","tags":["AI Gateway"]}},"/api/v1/ai/models":{"get":{"operationId":"listModels","parameters":[{"name":"type","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List available models with listed pricing","tags":["AI Gateway"]}},"/api/v1/ai/public/models":{"get":{"operationId":"listPublicModels","parameters":[{"name":"type","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public model catalog with listed pricing (no auth)","tags":["AI Gateway"]}},"/api/v1/ai/balance":{"get":{"operationId":"getBalance","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get AI credit balance (sats)","tags":["AI Account"]}},"/api/v1/ai/rate":{"get":{"operationId":"getRate","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Current BTC/USD rate + FX buffer (live sats pricing)","tags":["AI Account"]}},"/api/v1/ai/topup":{"post":{"operationId":"createTopup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTopupDto"}}}},"responses":{"201":{"description":"BOLT11 invoice created"}},"security":[{"bearer":[]}],"summary":"Create a Lightning topup invoice for AI credits","tags":["AI Account"]}},"/api/v1/ai/topup/{id}":{"get":{"operationId":"checkTopup","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Check topup status (credits balance when paid)","tags":["AI Account"]}},"/api/v1/ai/topups":{"get":{"operationId":"listTopups","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List recent topups","tags":["AI Account"]}},"/api/v1/ai/auto-topup":{"get":{"operationId":"getAutoTopup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Get NWC auto-topup settings","tags":["AI Account"]},"post":{"operationId":"saveAutoTopup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveAutoTopupDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Enable NWC auto-topup with threshold, amount and daily cap","tags":["AI Account"]},"delete":{"operationId":"removeAutoTopup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Disable and remove auto-topup settings","tags":["AI Account"]}},"/api/v1/ai/auto-topup/toggle":{"post":{"operationId":"toggleAutoTopup","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Enable or disable auto-topup","tags":["AI Account"]}},"/api/v1/ai/usage":{"get":{"operationId":"getUsage","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"pageCount","required":false,"in":"query","schema":{"type":"number"}},{"name":"model","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"AI usage history (per-query cost breakdown)","tags":["AI Account"]}},"/api/v1/ai/usage/summary":{"get":{"operationId":"getUsageSummary","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"AI usage summary (spend, queries, top models)","tags":["AI Account"]}},"/api/v1/ai/admin/sync":{"post":{"operationId":"forceSync","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Force model catalog sync from OpenRouter","tags":["AI Admin"]}},"/api/v1/ai/admin/sync-status":{"get":{"operationId":"syncStatus","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Model catalog sync status","tags":["AI Admin"]}},"/api/v1/ai/admin/models":{"get":{"operationId":"listModels","parameters":[{"name":"type","required":false,"in":"query","schema":{"type":"string"}},{"name":"active","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"q","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Full model catalog (active + inactive) with usage counts","tags":["AI Admin"]}},"/api/v1/ai/admin/models/activate":{"patch":{"operationId":"setActive","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Activate or deactivate a model (body: {id, active})","tags":["AI Admin"]}},"/api/v1/ai/admin/sync-media-pricing":{"post":{"operationId":"syncMediaPricing","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Force per-endpoint pricing enrichment for image/video models","tags":["AI Admin"]}},"/api/v1/ai/admin/stats":{"get":{"operationId":"stats","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Platform AI stats: top models, queries, revenue, margin","tags":["AI Admin"]}},"/api/v1/ai/tools/catalog":{"get":{"operationId":"catalog","parameters":[{"name":"category","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Public tool catalog (indicative sats pricing)","tags":["AI Tools"]}},"/api/v1/ai/tools":{"get":{"operationId":"list","parameters":[{"name":"category","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List available tools with indicative pricing","tags":["AI Tools"]}},"/api/v1/ai/tools/{toolId}/quote":{"post":{"operationId":"quote","parameters":[{"name":"toolId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteToolDto"}}}},"responses":{"200":{"description":"Live quote"}},"security":[{"bearer":[]}],"summary":"Live quote for a tool call (cost, listed price with margin, cap)","tags":["AI Tools"]}},"/api/v1/ai/tools/{toolId}/execute":{"post":{"operationId":"execute","parameters":[{"name":"toolId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteToolDto"}}}},"responses":{"201":{"description":"Tool call record"},"402":{"description":"Insufficient balance"}},"security":[{"bearer":[]}],"summary":"Execute a tool (debits AI credits, pays upstream over Lightning)","tags":["AI Tools"]}},"/api/v1/ai/tools/jobs/{callId}":{"get":{"operationId":"job","parameters":[{"name":"callId","required":true,"in":"path","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Poll an async tool job status / collect result","tags":["AI Tools"]}},"/api/v1/ai/tools/history":{"get":{"operationId":"history","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"pageCount","required":false,"in":"query","schema":{"type":"number"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Tool call history (per-call cost breakdown)","tags":["AI Tools"]}},"/api/v1/ai/admin/tools":{"get":{"operationId":"listTools","parameters":[{"name":"category","required":false,"in":"query","schema":{"type":"string"}},{"name":"active","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"q","required":false,"in":"query","schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Full tool catalog (active + inactive) with usage and margin","tags":["AI Tools Admin"]}},"/api/v1/ai/admin/tools/pricing":{"patch":{"operationId":"setPricing","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Set per-tool pricing overrides (body: {id, markupPct?, flatFeeSats?, maxCallSats?}; null clears to global default)","tags":["AI Tools Admin"]}},"/api/v1/ai/admin/tools/activate":{"patch":{"operationId":"setActive","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Activate or deactivate a tool (body: {id, active})","tags":["AI Tools Admin"]}},"/api/v1/ai/admin/tools/sync":{"post":{"operationId":"forceSync","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Force tool catalog sync from Sats4AI","tags":["AI Tools Admin"]}},"/api/v1/ai/admin/tools/sync-status":{"get":{"operationId":"syncStatus","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Tool catalog sync status","tags":["AI Tools Admin"]}},"/api/v1/ai/admin/tools/stats":{"get":{"operationId":"stats","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Tool platform stats: calls, revenue, COGS, margin","tags":["AI Tools Admin"]}},"/api/v1/uploads/handle":{"post":{"description":"Internal endpoint invoked by the `@vercel/blob/client` `upload()` function. Validates the requested pathname, then returns a constrained client token (image types only, 5 MB max, random suffix). Auth: zap_* API key with `uploads:write` scope, or dashboard JWT.","operationId":"handleClientUpload","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":"Client token generated (or upload-completed acknowledged)."}},"security":[{"bearer":[]}],"summary":"Mint client-upload token (used by @vercel/blob/client)","tags":["uploads"]}},"/api/v1/uploads/server":{"post":{"description":"Fallback upload path for API clients (zap_* key with `uploads:write` scope or JWT). Prefer the client-direct flow (`/uploads/handle`) for browsers — it bypasses function size limits and is cheaper.","operationId":"serverUpload","parameters":[{"name":"folder","required":false,"in":"query","schema":{"default":"misc","type":"string","enum":["avatars","banners","blog","misc"],"examples":["avatars"]}},{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"contentMediaType":"application/octet-stream"}}}}}},"responses":{"200":{"description":"File uploaded — returns the public blob URL.","content":{"application/json":{"schema":{"examples":[{"status":"success","statusCode":200,"message":"OK","data":{"url":"https://…public.blob.vercel-storage.com/avatars/u1/pic-aB3dEf.png","pathname":"avatars/u1/pic-aB3dEf.png"},"timestamp":"2026-10-23T10:00:00.000Z","path":"/api/v1/uploads/server"}]}}}}},"security":[{"bearer":[]}],"summary":"Upload an image through the server (≤5 MB)","tags":["uploads"]}},"/api/v1/uploads/status":{"get":{"operationId":"getStatus","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Blob credential status (diagnostic — no secrets exposed)","tags":["uploads"]}},"/api/v1/uploads":{"delete":{"description":"Deletes a blob from the connected store. Call this when replacing/removing images (e.g. old avatar) to avoid orphan storage costs. Auth: zap_* API key with `uploads:write` scope, or dashboard JWT.","operationId":"deleteBlob","parameters":[{"name":"X-API-Version","in":"header","required":false,"description":"API version for header-based versioning","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBlobDto"}}}},"responses":{"200":{"description":"Blob deleted."}},"security":[{"bearer":[]}],"summary":"Delete a blob by URL","tags":["uploads"]}}},"info":{"title":"ZapAPI","description":"$217","version":"1.0.0","contact":{"name":"ZapAPI","url":"https://github.com/k-kaundal/zapapi","email":"admin@zapapi.com"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"}},"tags":[{"name":"health","description":"Health check endpoints"},{"name":"auth","description":"Authentication & Authorization endpoints"},{"name":"users","description":"User management endpoints"},{"name":"sessions","description":"Session management endpoints"}],"servers":[{"url":"http://localhost:3001","description":"Local Development"},{"url":"https://api.zapapi.com","description":"Production"}],"components":{"securitySchemes":{"JWT":{"scheme":"bearer","bearerFormat":"JWT","type":"http","name":"JWT","description":"Enter your JWT access token","in":"header"},"API-Key":{"scheme":"bearer","bearerFormat":"API Key","type":"http","name":"API-Key","description":"Scoped API key for server integrations — zap_live_… or zap_test_…","in":"header"}},"schemas":{"TriggerCleanupDto":{"type":"object","properties":{"hours":{"type":"number","description":"Hours threshold for deleting old logs","default":24,"minimum":1,"examples":[24]}}},"RegisterDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address","examples":["john.doe@example.com"]},"firstName":{"type":"string","description":"User first name","minLength":2,"maxLength":50,"examples":["John"]},"lastName":{"type":"string","description":"User last name","minLength":2,"maxLength":50,"examples":["Doe"]},"password":{"type":"string","description":"User password (min 8 chars, must include uppercase, lowercase, number, and special character)","minLength":8,"maxLength":100,"examples":["SecurePass123!"]}},"required":["email","firstName","lastName","password"]},"LoginDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address","examples":["john.doe@example.com"]},"password":{"type":"string","description":"User password","examples":["SecurePass123!"]}},"required":["email","password"]},"RefreshTokenDto":{"type":"object","properties":{"refreshToken":{"type":"string","description":"Valid refresh token","examples":["eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."]}},"required":["refreshToken"]},"ForgotPasswordDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address for password reset","examples":["john.doe@example.com"]}},"required":["email"]},"ResetPasswordDto":{"type":"object","properties":{"token":{"type":"string","description":"Password reset token received via email","examples":["abc123def456ghi789"]},"newPassword":{"type":"string","description":"New password (min 8 chars, must include uppercase, lowercase, number, and special character)","minLength":8,"maxLength":100,"examples":["NewSecurePass123!"]}},"required":["token","newPassword"]},"VerifyEmailDto":{"type":"object","properties":{"token":{"type":"string","description":"Email verification token received via email","examples":["abc123def456ghi789"]}},"required":["token"]},"RevokeSessionDto":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID to revoke","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"required":["sessionId"]},"RevokeOtherSessionsDto":{"type":"object","properties":{"currentSessionId":{"type":"string","description":"Current session ID to keep active (optional)","examples":["123e4567-e89b-12d3-a456-426614174000"]}}},"CreateUserDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address","examples":["john.doe@example.com"]},"firstName":{"type":"string","description":"User first name","minLength":2,"maxLength":50,"examples":["John"]},"lastName":{"type":"string","description":"User last name","minLength":2,"maxLength":50,"examples":["Doe"]},"password":{"type":"string","description":"User password (optional - temporary password generated if not provided)","minLength":8,"maxLength":100,"examples":["SecurePass123!"]}},"required":["email","firstName","lastName"]},"UpdateUserDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address","examples":["john.doe@example.com"]},"firstName":{"type":"string","description":"User first name","minLength":2,"maxLength":50,"examples":["John"]},"lastName":{"type":"string","description":"User last name","minLength":2,"maxLength":50,"examples":["Doe"]},"password":{"type":"string","description":"User password (optional - temporary password generated if not provided)","minLength":8,"maxLength":100,"examples":["SecurePass123!"]},"isActive":{"type":"boolean","description":"User active status","examples":[true]},"avatarUrl":{"type":"string","description":"Avatar image URL (Vercel Blob)","examples":["https://yjsm6thumlqlykuv.public.blob.vercel-storage.com/avatars/u1/pic.png"]}}},"BulkUserIdsDto":{"type":"object","properties":{"ids":{"description":"Array of user UUIDs","type":"array","items":{"type":"string"},"examples":[["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]]}},"required":["ids"]},"CreateRoleDto":{"type":"object","properties":{"name":{"type":"string","description":"Role name","examples":["Editor"]},"description":{"type":"string","description":"Role description","examples":["Can edit content"]},"permissionIds":{"description":"Permission IDs to assign","type":"array","items":{"type":"string"},"examples":[["perm-uuid-1","perm-uuid-2"]]},"isSystemRole":{"type":"boolean","description":"System role (cannot be deleted)","default":false,"examples":[false]}},"required":["name","description"]},"UpdateRoleDto":{"type":"object","properties":{"name":{"type":"string","description":"Role name","examples":["Editor"]},"description":{"type":"string","description":"Role description","examples":["Can edit content"]},"permissionIds":{"description":"Permission IDs to assign","type":"array","items":{"type":"string"},"examples":[["perm-uuid-1","perm-uuid-2"]]},"isSystemRole":{"type":"boolean","description":"System role (cannot be deleted)","default":false,"examples":[false]}}},"CreatePermissionDto":{"type":"object","properties":{"name":{"type":"string","description":"Permission name","examples":["users:create"]},"description":{"type":"string","description":"Permission description","examples":["Can create users"]},"resource":{"type":"string","description":"Resource name","examples":["users"]},"action":{"type":"string","description":"Action name","examples":["create"]}},"required":["name","description","resource","action"]},"UpdatePermissionDto":{"type":"object","properties":{"name":{"type":"string","description":"Permission name","examples":["users:create"]},"description":{"type":"string","description":"Permission description","examples":["Can create users"]},"resource":{"type":"string","description":"Resource name","examples":["users"]},"action":{"type":"string","description":"Action name","examples":["create"]}}},"AssignRoleDto":{"type":"object","properties":{"roleIds":{"description":"Role IDs to assign to user","type":"array","items":{"type":"string"},"examples":[["role-uuid-1","role-uuid-2"]]}},"required":["roleIds"]},"SubscribeNewsletterDto":{"type":"object","properties":{"email":{"type":"string","description":"Email address to subscribe","examples":["john.doe@example.com"]},"firstName":{"type":"string","description":"First name (optional)","examples":["John"]},"lastName":{"type":"string","description":"Last name (optional)","examples":["Doe"]}},"required":["email"]},"SendNewsletterDto":{"type":"object","properties":{"subject":{"type":"string","description":"Newsletter subject","examples":["Monthly Updates - January 2026"]},"content":{"type":"string","description":"Newsletter HTML content","examples":["

Hello!

Here are our latest updates...

"]}},"required":["subject","content"]},"UpdateSubscriberDto":{"type":"object","properties":{"email":{"type":"string","description":"Subscriber email address","examples":["john.doe@example.com"]},"firstName":{"type":"string","description":"First name","examples":["John"]},"lastName":{"type":"string","description":"Last name","examples":["Doe"]},"isActive":{"type":"boolean","description":"Active status (subscribed / unsubscribed)","examples":[true]}}},"TrackVisitorDto":{"type":"object","properties":{"page":{"type":"string","description":"Page URL","examples":["/about"]},"referrer":{"type":"string","examples":["https://google.com"]},"language":{"type":"string","examples":["en-US"]},"screenWidth":{"type":"number","examples":[1920]},"screenHeight":{"type":"number","examples":[1080]},"sessionId":{"type":"string","examples":["session-uuid"]},"visitDuration":{"type":"number","description":"Visit duration in seconds","examples":[120]}},"required":["page"]},"CreateContactDto":{"type":"object","properties":{"name":{"type":"string","examples":["John Doe"]},"email":{"type":"string","examples":["john@example.com"]},"phone":{"type":"string","examples":["+1234567890"]},"subject":{"type":"string","examples":["General Inquiry"]},"message":{"type":"string","examples":["I would like to know more about your services."]}},"required":["name","email","subject","message"]},"UpdateContactDto":{"type":"object","properties":{"status":{"type":"string","enum":["new","read","replied","archived"],"examples":["read"]}}},"CreateBlogPostDto":{"type":"object","properties":{"title":{"type":"string","minLength":5,"maxLength":200,"examples":["How to Build a Modern Web App"]},"content":{"type":"string","description":"HTML content from rich text editor","examples":["

Introduction

Content here...

Introduction

Content here...

"]},"excerpt":{"type":"string","maxLength":500,"examples":["Learn how to build modern web applications with React and Node.js"]},"featuredImage":{"type":"string","examples":["https://example.com/images/post.jpg"]},"status":{"type":"string","enum":["draft","published","archived"],"default":"draft","examples":["draft"]},"metaDescription":{"type":"string","maxLength":160,"examples":["Build modern web applications with the latest technologies"]},"metaKeywords":{"type":"string","examples":["web development, react, nodejs, tutorial"]},"tags":{"type":"array","items":{"type":"string"},"examples":[["react","nodejs","tutorial"]]},"category":{"type":"string","examples":["Web Development"]}}},"CreateProjectDto":{"type":"object","properties":{"name":{"type":"string","description":"Project name","minLength":3,"maxLength":100,"examples":["E-commerce Store"]},"description":{"type":"string","description":"Project description","examples":["Main production e-commerce store"]},"environment":{"type":"string","description":"Environment type","enum":["development","production"],"default":"development"}},"required":["name","environment"]},"UpdateProjectDto":{"type":"object","properties":{"name":{"type":"string","description":"Project name","examples":["E-commerce Store"]},"description":{"type":"string","description":"Project description"},"status":{"type":"string","description":"Project status","enum":["active","archived"]}}},"CreateProviderDto":{"type":"object","properties":{"name":{"type":"string","description":"Provider name","minLength":3,"maxLength":100,"examples":["LNbits Production"]},"type":{"type":"string","description":"Provider type","enum":["lnbits","nwc","lnd"],"examples":["lnbits"]},"url":{"type":"string","description":"Provider URL","examples":["https://lnbits.example.com"]},"adminKey":{"type":"string","description":"Admin API key (for LNbits)","examples":["your-admin-key-here"]},"invoiceKey":{"type":"string","description":"Invoice API key (for LNbits)","examples":["your-invoice-key-here"]},"apiKey":{"type":"string","description":"API key or connection string (for other providers)","examples":["your-api-key-here"]},"projectId":{"type":"string","description":"Associated project ID","examples":["uuid-of-project"]}},"required":["name","type","url"]},"CreateApiKeyDto":{"type":"object","properties":{"name":{"type":"string","description":"API key name","minLength":3,"maxLength":100,"examples":["Production API Key"]},"environment":{"type":"string","description":"Environment type","enum":["test","live"],"examples":["test"]},"projectId":{"type":"string","description":"Associated project ID","examples":["uuid-of-project"]},"expiresAt":{"type":"string","description":"Expiration date (ISO 8601)","examples":["2025-12-31T23:59:59Z"]},"scopes":{"description":"Permission scopes. Defaults to [\"*\"] (full access). Example: [\"invoices:read\", \"invoices:write\"]","type":"array","items":{"type":"array"},"examples":[["invoices:read","invoices:write"]]}},"required":["name","environment"]},"CreateInvoiceDto":{"type":"object","properties":{"amount":{"type":"number","description":"Amount — in satoshis when currency is \"sat\" (default), or in the fiat currency when currency is e.g. \"USD\"","minimum":1,"examples":[5000]},"currency":{"type":"string","description":"Denomination: \"sat\" (default) or a fiat currency code (USD, EUR, GBP, INR, BRL, JPY, CAD, AUD). Fiat amounts are converted to sats at the current rate, snapshotted at creation.","examples":["sat"]},"description":{"type":"string","description":"Invoice description","examples":["Order #1234"]},"projectId":{"type":"string","description":"Project ID. Optional when the API key is project-scoped (project keys fill this in automatically). The invoice settles to the project's configured settlement wallet.","examples":["uuid-of-project"]},"providerId":{"type":"string","description":"DEPRECATED — settlement is resolved from the project's settlement wallet (dashboard → project → Settlement Wallet). Kept for backward compatibility with legacy LNbits-provider integrations; ignored for new integrations.","deprecated":true,"examples":["uuid-of-provider"]},"expirySeconds":{"type":"number","description":"Expiry time in seconds (default: 3600 = 1 hour)","minimum":60,"maximum":86400,"examples":[3600]},"metadata":{"type":"object","description":"Additional metadata (JSON)","examples":[{"orderId":"1234","customerEmail":"customer@example.com"}]},"couponCode":{"type":"string","description":"Coupon code — the project discount is applied and snapshotted on the invoice (amountDueSats = amount - discountSats). The payer pays amountDueSats.","examples":["LAUNCH20"]},"successUrl":{"type":"string","description":"Merchant success URL — hosted checkout redirects here on payment (paymentHash + preimage appended). Stripe-style success redirect.","examples":["https://shop.example.com/success"]},"cancelUrl":{"type":"string","description":"Merchant cancel/back URL shown on the hosted checkout","examples":["https://shop.example.com/cart"]}},"required":["amount","description"]},"CreateDiscountDto":{"type":"object","properties":{"projectId":{"type":"string","description":"Project the discount applies to"},"mode":{"type":"string","description":"\"coupon\" = customer enters the code at checkout · \"offer\" = applied automatically in its validity window","enum":["coupon","offer"],"default":"coupon"},"code":{"type":"string","description":"Code (uppercased; unique per project)","examples":["LAUNCH20"]},"type":{"type":"string","description":"\"percent\" or \"amount\" (fixed sats off)","enum":["percent","amount"]},"percentOff":{"type":"number","description":"1–99 (when type=percent)"},"amountOffSats":{"type":"number","description":"Fixed sats off (when type=amount)"},"startsAt":{"type":"string","description":"Validity start (ISO; empty = from now)"},"endsAt":{"type":"string","description":"Validity end (ISO; empty = no expiry)"},"maxRedemptions":{"type":"number","description":"Max total redemptions (empty = unlimited)"}},"required":["projectId","code","type"]},"UpdateDiscountDto":{"type":"object","properties":{}},"ValidateCouponDto":{"type":"object","properties":{}},"ResolveOfferDto":{"type":"object","properties":{}},"CreateRefundDto":{"type":"object","properties":{"type":{"type":"string","description":"Refund type: \"credit\" (record only, settle off-band) or \"payment\" (send sats back)","enum":["credit","payment"],"default":"payment"},"amountSats":{"type":"number","description":"Amount in sats to refund. Omit for a full refund of the invoice amount. Partial refunds are allowed.","examples":[5000]},"destination":{"type":"string","description":"Where to send the refund: a BOLT11 invoice or lightning address (name@domain.com). Required for type=payment.","examples":["customer@wallet.com"]},"reason":{"type":"string","description":"Reason for the refund (shown in history)","examples":["Customer requested cancellation"]}},"required":["type"]},"CreateWebhookDto":{"type":"object","properties":{"url":{"type":"string","description":"Webhook endpoint URL (http/https)","examples":["https://api.yourapp.com/webhooks/zapapi"]},"events":{"description":"Events to subscribe to","type":"array","items":{"type":"string"},"examples":[["invoice.paid","invoice.expired"]]},"projectId":{"type":"string","description":"Associated project ID","examples":["uuid-of-project"]}},"required":["url","events","projectId"]},"CreatePlanDto":{"type":"object","properties":{}},"UpdatePlanDto":{"type":"object","properties":{}},"SubscribeDto":{"type":"object","properties":{}},"UpdateCustomerDto":{"type":"object","properties":{}},"UpdatePreferencesDto":{"type":"object","properties":{"emailEnabled":{"type":"boolean"},"emailPayments":{"type":"boolean"},"emailTips":{"type":"boolean"},"emailSubscriptions":{"type":"boolean"},"emailSecurity":{"type":"boolean"},"emailDigest":{"type":"boolean"}}},"CreateNwcConnectionDto":{"type":"object","properties":{"name":{"type":"string","description":"Friendly label for the wallet switcher","examples":["My Alby Hub"]},"connectionString":{"type":"string","description":"Nostr Wallet Connect URI from your wallet (Alby Hub → App Store → Connect app, coinos, Umbrel, LNbits NWC extension, …)","examples":["nostr+walletconnect://69effe7b...?relay=wss://relay.getalby.com/v1&secret=c60320b3..."]}},"required":["name","connectionString"]},"UpdateNwcConnectionDto":{"type":"object","properties":{"name":{"type":"string","examples":["Savings wallet"]}}},"UpsertBioPageDto":{"type":"object","properties":{}},"CreateBlockDto":{"type":"object","properties":{}},"UpdateBlockDto":{"type":"object","properties":{}},"ReorderBlocksDto":{"type":"object","properties":{}},"BoostProfileDto":{"type":"object","properties":{}},"CheckoutDto":{"type":"object","properties":{"tier":{"type":"string","enum":["zap","pro","business"]},"period":{"type":"string","enum":["month","year"],"default":"month"},"payNow":{"type":"boolean","description":"Pay immediately from my ZapAPI wallet"},"walletId":{"type":"string","description":"Pay from a specific account wallet"}},"required":["tier","period"]},"AdminSetTierDto":{"type":"object","properties":{"tier":{"type":"string","enum":["free","zap","pro","business"]},"days":{"type":"number","description":"Days of access to grant (default 30)","default":30},"reason":{"type":"string","description":"Audit note (gift/comp/support reason)"}},"required":["tier"]},"AdminExtendPeriodDto":{"type":"object","properties":{"days":{"type":"number","description":"Days to add (negative to shorten)"}},"required":["days"]},"AdminOverridesDto":{"type":"object","properties":{"overrides":{"type":"object","description":"Entitlement overrides — set a value to override the tier default, set null to clear a key","examples":[{"apiQuota":50000,"maxWallets":5,"marketplaceFeePct":null}]}},"required":["overrides"]},"AdminBoostCreditDto":{"type":"object","properties":{"sats":{"type":"number","description":"Boost credit sats to grant this period"}},"required":["sats"]},"CreateGiftCardDto":{"type":"object","properties":{"balanceSats":{"type":"number","description":"Initial balance in sats","examples":[21000]},"issueType":{"type":"string","description":"\"paid\" = buyer pays a purchase invoice now (card activates on settlement) · \"free\" = merchant-funded comp card (active immediately)","enum":["paid","free"],"default":"paid"},"projectId":{"type":"string","description":"Optional project — paid issuance settles to its settlement wallet"},"expiresAt":{"type":"string","description":"Optional expiry (ISO)"},"note":{"type":"string","description":"Private note (e.g. who this is for)"}},"required":["balanceSats","issueType"]},"RedeemGiftCardDto":{"type":"object","properties":{}},"CreateWithdrawalDto":{"type":"object","properties":{}},"CreatePaymentLinkDto":{"type":"object","properties":{"description":{"type":"string","description":"Payment link description","examples":["Premium Subscription - Monthly"]},"type":{"type":"string","description":"Payment type","enum":["fixed","flexible"],"examples":["fixed"]},"amount":{"type":"number","description":"Fixed amount in satoshis (required if type is fixed)","examples":[5000]},"minAmount":{"type":"number","description":"Minimum amount in satoshis (if type is flexible)","examples":[100]},"maxAmount":{"type":"number","description":"Maximum amount in satoshis (if type is flexible)","examples":[1000000]},"collectEmail":{"type":"boolean","description":"Collect customer email","default":false,"examples":[false]},"collectName":{"type":"boolean","description":"Collect customer name","default":false,"examples":[false]},"expiresAt":{"type":"string","description":"Expiration date (ISO 8601)","examples":["2025-12-31T23:59:59Z"]},"projectId":{"type":"string","description":"Associated project ID (optional for quick links)","examples":["uuid-of-project"]},"providerId":{"type":"string","description":"Provider ID to use for payments (optional - falls back to default/platform)","examples":["uuid-of-provider"]},"isQuickLink":{"type":"boolean","description":"Whether this is a quick link (personal use, no project)","default":false,"examples":[false]},"commentChars":{"type":"number","description":"Allow comments on the payment page (max comment chars)","examples":[100]}},"required":["description","type","collectEmail","collectName"]},"LinkWalletDto":{"type":"object","properties":{"nwcConnectionId":{"type":["string","null"],"description":"NWC connection id (your own wallet) to receive payments on. Null clears it.","examples":["b7e901ca-fc45-43fa-bdf8-bd59db919dd7"]},"accountWalletId":{"type":["string","null"],"description":"Specific account wallet id to receive payments. Null clears it.","examples":["f07ea461-7721-4115-8a5e-1ca4466f6463"]}}},"ClaimAddressDto":{"type":"object","properties":{}},"UpdateClaimedAddressDto":{"type":"object","properties":{}},"ApplyProviderDto":{"type":"object","properties":{"name":{"type":"string","examples":["NostrFeed"]},"baseUrl":{"type":"string","description":"LNbits base URL (no trailing slash)","examples":["https://ln.nostrfeed.com"]},"invoiceKey":{"type":"string","description":"Read-only LNbits invoice key (X-Api-Key) from any wallet on the instance — used only for the domain catalog, can never spend"},"contactEmail":{"type":"string","description":"Contact shown to buyers for refunds/renewals","examples":["support@nostrfeed.com"]},"logoUrl":{"type":"string","examples":["https://nostrfeed.com/logo.png"]}},"required":["name","baseUrl","invoiceKey"]},"RegisterProviderDto":{"type":"object","properties":{"name":{"type":"string","examples":["NostrFeed"]},"logoUrl":{"type":"string","examples":["https://nostrfeed.com/logo.png"]},"baseUrl":{"type":"string","description":"LNbits base URL (no trailing slash)","examples":["https://ln.nostrfeed.com"]},"invoiceKey":{"type":"string","description":"Read-only LNbits invoice key (X-Api-Key) — catalog import only, cannot spend"}},"required":["name","baseUrl","invoiceKey"]},"UpdateProviderDto":{"type":"object","properties":{"name":{"type":"string"},"logoUrl":{"type":"string"},"status":{"type":"string","enum":["active","paused"]},"commissionPct":{"type":"number","description":"Marketplace commission percent (default 0)"},"invoiceKey":{"type":"string","description":"Rotate the read-only invoice key"},"contactEmail":{"type":"string","description":"Provider contact (refunds/renewals)"}}},"RejectProviderDto":{"type":"object","properties":{"reason":{"type":"string","examples":["Domain does not resolve nostr.json"]}},"required":["reason"]},"CreateMarketplaceOrderDto":{"type":"object","properties":{"providerId":{"type":"string","description":"AddressProvider id"},"domainCatalogId":{"type":"string","description":"MarketplaceDomain catalog row id"},"localPart":{"type":"string","examples":["alice"]},"years":{"type":"number","examples":[1]},"expectedPriceSats":{"type":"number","description":"Sats quote shown at search time — re-quote guard (§2.2): reservation drift >5% requires re-confirmation"},"acceptRequote":{"type":"boolean","description":"Set true to accept the re-quoted price after a drift warning"},"pubkey":{"type":"string","description":"Nostr pubkey (hex) for the address; defaults to the wallet pubkey"},"promoCode":{"type":"string","description":"Promo code (provider-side)"}},"required":["providerId","domainCatalogId","localPart"]},"PublishVerificationDto":{"type":"object","properties":{"relays":{"description":"Relays to publish to (defaults to the wallet-generated identity relays)","type":"array","items":{"type":"string"}}}},"SubmitAppDto":{"type":"object","properties":{"name":{"type":"string","examples":["ZapStream"]},"description":{"type":"string","examples":["Live stream and zap in real time"]},"url":{"type":"string","examples":["https://zap.stream"]},"iconUrl":{"type":"string"},"category":{"type":"string","enum":["wallet","social","tools","games","media","commerce","developer","other"],"examples":["media"]},"tags":{"type":"array","items":{"type":"string"},"examples":[["streaming","zaps"]]},"lnAddress":{"type":"string","description":"Zap target lightning address. Omit to auto-provision app-{slug}@zapapi.app on our engine (zaps land in your ZapAPI wallet).","examples":["tips@zap.stream"]},"nostrPubkey":{"type":"string","description":"Owner nostr pubkey (hex) — shown on the card"}},"required":["name","description","url","category"]},"UpdateAppDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string","description":"Changing the URL re-triggers review"},"iconUrl":{"type":"string"},"category":{"type":"string","enum":["wallet","social","tools","games","media","commerce","developer","other"]},"tags":{"type":"array","items":{"type":"string"}}}},"BoostAppDto":{"type":"object","properties":{"product":{"type":"string","enum":["1k-3d","5k-7d","20k-14d"],"examples":["5k-7d"]},"walletId":{"type":"string","description":"Pay from a specific account wallet (default = default wallet)"},"payNow":{"type":"boolean","description":"Pay immediately from my ZapAPI wallet after invoicing","default":false}},"required":["product"]},"RejectAppDto":{"type":"object","properties":{"reason":{"type":"string"}},"required":["reason"]},"CreateTopupDto":{"type":"object","properties":{"amountSats":{"type":"number","description":"Sats to top up. The Lightning invoice is created for exactly this amount; on payment the balance is credited amount + bonus (default +5%).","minimum":100,"maximum":10000000,"examples":[5000]}},"required":["amountSats"]},"SaveAutoTopupDto":{"type":"object","properties":{"nwcConnectionId":{"type":"string","description":"NWC connection id to pay auto-topups from"},"thresholdSats":{"type":"number","description":"Trigger auto-topup when balance falls below (sats)","examples":[500]},"topupSats":{"type":"number","description":"Amount to top up per trigger (sats)","examples":[5000]},"dailyCapSats":{"type":"number","description":"Max auto-topup spend per UTC day (sats)","examples":[20000]}},"required":["nwcConnectionId","thresholdSats","topupSats","dailyCapSats"]},"QuoteToolDto":{"type":"object","properties":{}},"ExecuteToolDto":{"type":"object","properties":{}},"DeleteBlobDto":{"type":"object","properties":{"url":{"type":"string","examples":["https://yjsm6thumlqlykuv.public.blob.vercel-storage.com/avatars/x.png"]}},"required":["url"]}}}},"proxyUrl":"$undefined"},"document":"/vercel/path0/server/src/api-docs/openapi.json","operations":[{"method":"patch","path":"/api/v1/relay-passes/{id}/status","tags":["Relay Passes"]}],"showDescription":true}]}]]}]

Enable/disable a relay pass

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Header Parameters

Response Body