bunq-cli 0.2.0__py3-none-any.whl

bunq_cli/commands/oauth_client.py

@@ -0,0 +1,113 @@
+"""OAuth client management commands."""
+
+from __future__ import annotations
+
+import click
+from bunq.sdk.model.generated.endpoint import (
+    OauthCallbackUrlApiObject,
+    OauthClientApiObject,
+)
+
+from bunq_cli.config import (
+    get_oauth_client,
+    load_config,
+    remove_oauth_client,
+    save_config,
+    set_oauth_client,
+)
+from bunq_cli.main import Context, pass_context, yes_option
+from bunq_cli.oauth import REDIRECT_URI
+from bunq_cli.output import echo_output
+
+
+@click.group(name="oauth-client")
+def oauth_client() -> None:
+    """Manage the OAuth client for browser-based login."""
+
+
+@oauth_client.command("register")
+@pass_context
+def register(ctx: Context) -> None:
+    """Register a new OAuth client and store its credentials.
+
+    Requires an active session (run 'bunq login --token' first); the OAuth
+    client is owned by the selected profile's user.
+    Automatically adds the CLI callback URL.
+    """
+    client = ctx.get_client(write=True)  # noqa: F841 -- ensures SDK context is loaded
+
+    config = load_config(ctx.config_path)
+    existing = get_oauth_client(config)
+    if existing.get("client_id"):
+        raise click.ClickException(
+            "An OAuth client is already registered. "
+            "Run 'bunq oauth-client delete' first to replace it."
+        )
+
+    # Create the OAuth client
+    response = OauthClientApiObject.create(status="ACTIVE")
+    oauth_id = response.value
+
+    # Fetch the client details (client_id + secret)
+    detail = OauthClientApiObject.get(oauth_id).value
+    client_id = detail.client_id
+    client_secret = detail.secret
+
+    # Register the CLI callback URL
+    OauthCallbackUrlApiObject.create(oauth_id, url=REDIRECT_URI)
+
+    # Persist to config
+    config = set_oauth_client(config, client_id, client_secret, oauth_id, ctx.profile_name)
+    save_config(config, ctx.config_path)
+
+    if not ctx.quiet:
+        click.echo(f"OAuth client registered (ID: {oauth_id}).")
+        click.echo(f"Client ID:     {client_id}")
+        click.echo(f"Callback URL:  {REDIRECT_URI}")
+        click.echo()
+        click.echo("You can now log in with: bunq login")
+
+
+@oauth_client.command("show")
+@pass_context
+def show(ctx: Context) -> None:
+    """Show the stored OAuth client credentials."""
+    config = load_config(ctx.config_path)
+    oauth = get_oauth_client(config)
+    if not oauth.get("client_id"):
+        raise click.ClickException(
+            "No OAuth client registered. Run 'bunq oauth-client register' first."
+        )
+    data = {
+        "oauth_client_id": oauth["oauth_client_id"],
+        "client_id": oauth["client_id"],
+        "client_secret": oauth["client_secret"],
+        "callback_url": REDIRECT_URI,
+        "profile": oauth.get("profile", ""),
+    }
+    echo_output(data, fmt=ctx.output_format)
+
+
+@oauth_client.command("delete")
+@yes_option
+@pass_context
+def delete(ctx: Context, yes: bool) -> None:
+    """Delete the OAuth client and remove stored credentials."""
+    config = load_config(ctx.config_path)
+    oauth = get_oauth_client(config)
+    oauth_id = oauth.get("oauth_client_id")
+    # The OAuth client lives under the user that registered it.
+    client = ctx.get_client(write=True, profile=oauth.get("profile"))  # noqa: F841
+    ctx.confirm("Delete the OAuth client?", yes)
+
+    if oauth_id:
+        try:
+            OauthClientApiObject.update(oauth_id, status="CANCELLED")
+        except Exception:
+            pass  # best-effort: client may already be gone
+
+    config = remove_oauth_client(config)
+    save_config(config, ctx.config_path)
+
+    if not ctx.quiet:
+        click.echo("OAuth client deleted.")

bunq_cli/commands/payments.py

@@ -0,0 +1,90 @@
+"""Payments commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context, yes_option
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "created", "amount", "currency", "counterparty", "description"]
+
+
+@click.group()
+def payments() -> None:
+    """Manage payments."""
+
+
+@payments.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@click.option("--all", "fetch_all", is_flag=True, help="Fetch all pages.")
+@click.option("--count", type=int, default=25, help="Number of results per page.")
+@click.option("--older-id", type=int, default=None, help="Cursor: fetch results older than this ID.")
+@click.option("--newer-id", type=int, default=None, help="Cursor: fetch results newer than this ID.")
+@pass_context
+def list_payments(
+    ctx: Context,
+    account_id: int | None,
+    fetch_all: bool,
+    count: int,
+    older_id: int | None,
+    newer_id: int | None,
+) -> None:
+    """List payments. Returns one page by default; use --all to fetch everything."""
+    client = ctx.get_client()
+    if fetch_all:
+        data = client.list_all_payments(account_id=account_id)
+    else:
+        data = client.list_payments(
+            account_id=account_id,
+            count=count,
+            older_id=older_id,
+            newer_id=newer_id,
+        )
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@payments.command("get")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@pass_context
+def get_payment(ctx: Context, id: int, account_id: int | None) -> None:
+    """Get a single payment by ID."""
+    client = ctx.get_client()
+    data = client.get_payment(id, account_id=account_id)
+    echo_output(data, fmt=ctx.output_format)
+
+
+@payments.command("create")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@click.option("--amount", required=True, help="Amount to send (e.g., 25.00).")
+@click.option("--currency", default="EUR", help="Currency code (default: EUR).")
+@click.option("--recipient-iban", required=True, help="Recipient IBAN.")
+@click.option("--recipient-name", required=True, help="Recipient name.")
+@click.option("--description", required=True, help="Payment description.")
+@yes_option
+@pass_context
+def create_payment(
+    ctx: Context,
+    account_id: int | None,
+    amount: str,
+    currency: str,
+    recipient_iban: str,
+    recipient_name: str,
+    description: str,
+    yes: bool,
+) -> None:
+    """Create a payment."""
+    client = ctx.get_client(write=True)
+    source = f"account {account_id}" if account_id else "the primary account"
+    ctx.confirm(f"Pay {amount} {currency} to {recipient_name} ({recipient_iban}) from {source}?", yes)
+    payment_id = client.create_payment(
+        amount=amount,
+        currency=currency,
+        recipient_iban=recipient_iban,
+        recipient_name=recipient_name,
+        description=description,
+        account_id=account_id,
+    )
+    if not ctx.quiet:
+        click.echo(f"Payment created (ID: {payment_id}).")

bunq_cli/commands/profiles.py

@@ -0,0 +1,91 @@
+"""Profile (client) management commands."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+
+from bunq_cli.config import (
+    load_config,
+    resolve_profile,
+    save_config,
+    validate_profile_name,
+)
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+
+@click.group()
+def profiles() -> None:
+    """Manage profiles (one per bunq login, e.g. per client)."""
+
+
+@profiles.command("list")
+@pass_context
+def list_profiles(ctx: Context) -> None:
+    """List profiles."""
+    config = load_config(ctx.config_path)
+    default = config.get("default_profile")
+    data = [
+        {
+            "default": "*" if name == default else "",
+            "name": name,
+            "display_name": p.get("display_name", ""),
+            "environment": "sandbox" if p.get("sandbox") else "production",
+            "read_only": p.get("read_only", False),
+            "logged_in": Path(p["context_path"]).expanduser().exists(),
+        }
+        for name, p in config.get("profiles", {}).items()
+    ]
+    echo_output(data, fmt=ctx.output_format)
+
+
+@profiles.command("use")
+@click.argument("name")
+@pass_context
+def use_profile(ctx: Context, name: str) -> None:
+    """Set the default profile."""
+    config = load_config(ctx.config_path)
+    resolve_profile(config, name)
+    config["default_profile"] = name
+    save_config(config, ctx.config_path)
+    if not ctx.quiet:
+        click.echo(f"Default profile is now '{name}'.")
+
+
+@profiles.command("rename")
+@click.argument("old")
+@click.argument("new")
+@pass_context
+def rename_profile(ctx: Context, old: str, new: str) -> None:
+    """Rename a profile."""
+    validate_profile_name(new)
+    config = load_config(ctx.config_path)
+    resolve_profile(config, old)
+    if new in config["profiles"]:
+        raise click.ClickException(f"Profile '{new}' already exists.")
+    config["profiles"][new] = config["profiles"].pop(old)
+    if config.get("default_profile") == old:
+        config["default_profile"] = new
+    if config.get("oauth", {}).get("profile") == old:
+        config["oauth"]["profile"] = new
+    save_config(config, ctx.config_path)
+    if not ctx.quiet:
+        click.echo(f"Profile '{old}' renamed to '{new}'.")
+
+
+@profiles.command("set")
+@click.argument("name")
+@click.option("--read-only/--read-write", default=None, help="Block or allow commands that change data.")
+@pass_context
+def set_profile_options(ctx: Context, name: str, read_only: bool | None) -> None:
+    """Change profile settings."""
+    if read_only is None:
+        raise click.ClickException("Nothing to change. Use --read-only or --read-write.")
+    config = load_config(ctx.config_path)
+    resolve_profile(config, name)
+    config["profiles"][name]["read_only"] = read_only
+    save_config(config, ctx.config_path)
+    if not ctx.quiet:
+        click.echo(f"Profile '{name}' is now {'read-only' if read_only else 'read-write'}.")

bunq_cli/commands/requests.py

@@ -0,0 +1,122 @@
+"""Payment request commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context, yes_option
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "created", "amount", "currency", "counterparty", "description", "status"]
+
+
+@click.group()
+def requests() -> None:
+    """Manage payment requests."""
+
+
+@requests.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@pass_context
+def list_requests(ctx: Context, account_id: int | None) -> None:
+    """List outgoing payment requests."""
+    client = ctx.get_client()
+    data = client.list_requests(account_id=account_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@requests.command("get")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@pass_context
+def get_request(ctx: Context, id: int, account_id: int | None) -> None:
+    """Get a single outgoing payment request."""
+    client = ctx.get_client()
+    data = client.get_request(id, account_id=account_id)
+    echo_output(data, fmt=ctx.output_format)
+
+
+@requests.command("create")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@click.option("--amount", required=True, help="Amount to request (e.g., 35.00).")
+@click.option("--currency", default="EUR", help="Currency code (default: EUR).")
+@click.option("--counterparty-email", default=None, help="Recipient email address.")
+@click.option("--counterparty-phone", default=None, help="Recipient phone number (e.g., +31612345678).")
+@click.option("--description", required=True, help="Request description.")
+@pass_context
+def create_request(
+    ctx: Context,
+    account_id: int | None,
+    amount: str,
+    currency: str,
+    counterparty_email: str | None,
+    counterparty_phone: str | None,
+    description: str,
+) -> None:
+    """Create a payment request."""
+    if counterparty_email:
+        cp_type, cp_value = "EMAIL", counterparty_email
+    elif counterparty_phone:
+        cp_type, cp_value = "PHONE_NUMBER", counterparty_phone
+    else:
+        raise click.ClickException("Provide --counterparty-email or --counterparty-phone.")
+
+    client = ctx.get_client(write=True)
+    request_id = client.create_request(
+        amount=amount,
+        currency=currency,
+        counterparty_type=cp_type,
+        counterparty_value=cp_value,
+        description=description,
+        account_id=account_id,
+    )
+    if not ctx.quiet:
+        click.echo(f"Payment request created (ID: {request_id}).")
+
+
+@requests.command("revoke")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@pass_context
+def revoke_request(ctx: Context, id: int, account_id: int | None) -> None:
+    """Revoke a pending payment request."""
+    client = ctx.get_client(write=True)
+    client.revoke_request(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"Request {id} revoked.")
+
+
+@requests.command("incoming")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@pass_context
+def list_incoming(ctx: Context, account_id: int | None) -> None:
+    """List incoming payment requests."""
+    client = ctx.get_client()
+    data = client.list_incoming_requests(account_id=account_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@requests.command("accept")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@yes_option
+@pass_context
+def accept_request(ctx: Context, id: int, account_id: int | None, yes: bool) -> None:
+    """Accept (and pay) an incoming payment request."""
+    client = ctx.get_client(write=True)
+    ctx.confirm(f"Accept and pay incoming request {id}?", yes)
+    client.accept_request(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"Request {id} accepted.")
+
+
+@requests.command("reject")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID.")
+@pass_context
+def reject_request(ctx: Context, id: int, account_id: int | None) -> None:
+    """Reject an incoming payment request."""
+    client = ctx.get_client(write=True)
+    client.reject_request(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"Request {id} rejected.")

bunq_cli/commands/sandbox.py

@@ -0,0 +1,25 @@
+"""Sandbox helper commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.client import create_sandbox_user
+from bunq_cli.commands.login import login
+
+
+@click.group()
+def sandbox() -> None:
+    """Sandbox environment helpers."""
+
+
+@sandbox.command("create-user")
+@click.option("--login", "login_profile", metavar="PROFILE", default=None, help="Log in with the new user under this profile name.")
+@click.pass_context
+def create_user(click_ctx: click.Context, login_profile: str | None) -> None:
+    """Create a sandbox test user and print its API key."""
+    api_key = create_sandbox_user()
+    if login_profile:
+        click_ctx.invoke(login, profile_name=login_profile, token=api_key, sandbox=True)
+    else:
+        click.echo(api_key)

bunq_cli/commands/scheduled.py

@@ -0,0 +1,108 @@
+"""Scheduled payment commands."""
+
+from __future__ import annotations
+
+from datetime import datetime, timezone
+
+import click
+
+from bunq_cli.main import Context, pass_context, yes_option
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "status", "amount", "currency", "counterparty", "description", "every", "next"]
+UNITS = ["ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
+DATETIME_FORMATS = ["%Y-%m-%d", "%Y-%m-%d %H:%M", "%Y-%m-%dT%H:%M"]
+
+
+def _to_api_time(value: datetime) -> str:
+    # bunq expects UTC; naive input is treated as local time.
+    return value.astimezone(timezone.utc).strftime("%Y-%m-%d %H:%M:%S")
+
+
+@click.group("scheduled-payments")
+def scheduled() -> None:
+    """Manage scheduled (recurring) payments."""
+
+
+@scheduled.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def list_scheduled(ctx: Context, account_id: int | None) -> None:
+    """List scheduled payments."""
+    client = ctx.get_client()
+    data = client.list_scheduled_payments(account_id=account_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@scheduled.command("get")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def get_scheduled(ctx: Context, id: int, account_id: int | None) -> None:
+    """Get a single scheduled payment."""
+    client = ctx.get_client()
+    data = client.get_scheduled_payment(id, account_id=account_id)
+    echo_output(data, fmt=ctx.output_format)
+
+
+@scheduled.command("create")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@click.option("--amount", required=True, help="Amount per payment (e.g., 25.00).")
+@click.option("--currency", default="EUR", help="Currency code (default: EUR).")
+@click.option("--recipient-iban", required=True, help="Recipient IBAN.")
+@click.option("--recipient-name", required=True, help="Recipient name.")
+@click.option("--description", required=True, help="Payment description.")
+@click.option("--schedule-date", "start", required=True, type=click.DateTime(DATETIME_FORMATS), help="First payment (local time, e.g. 2026-11-01 or '2026-11-01 09:00').")
+@click.option("--end-date", "end", type=click.DateTime(DATETIME_FORMATS), default=None, help="Stop after this date (optional).")
+@click.option("--frequency", "unit", type=click.Choice(UNITS, case_sensitive=False), default="ONCE", help="How often to pay (default: ONCE).")
+@click.option("--every", type=click.IntRange(min=1), default=1, help="Repeat every N periods, e.g. --every 2 --frequency WEEKLY.")
+@yes_option
+@pass_context
+def create_scheduled(
+    ctx: Context,
+    account_id: int | None,
+    amount: str,
+    currency: str,
+    recipient_iban: str,
+    recipient_name: str,
+    description: str,
+    start: datetime,
+    end: datetime | None,
+    unit: str,
+    every: int,
+    yes: bool,
+) -> None:
+    """Schedule a (recurring) payment."""
+    client = ctx.get_client(write=True)
+    source = f"account {account_id}" if account_id else "the primary account"
+    ctx.confirm(
+        f"Schedule {amount} {currency} to {recipient_name} ({recipient_iban}) from {source}, "
+        f"starting {start:%Y-%m-%d %H:%M}, {unit.upper()}?",
+        yes,
+    )
+    schedule_id = client.create_scheduled_payment(
+        amount=amount,
+        currency=currency,
+        recipient_iban=recipient_iban,
+        recipient_name=recipient_name,
+        description=description,
+        time_start=_to_api_time(start),
+        time_end=_to_api_time(end) if end else None,
+        recurrence_unit=unit.upper(),
+        recurrence_size=every,
+        account_id=account_id,
+    )
+    if not ctx.quiet:
+        click.echo(f"Scheduled payment created (ID: {schedule_id}).")
+
+
+@scheduled.command("delete")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def cancel_scheduled(ctx: Context, id: int, account_id: int | None) -> None:
+    """Cancel a scheduled payment."""
+    client = ctx.get_client(write=True)
+    client.cancel_scheduled_payment(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"Scheduled payment {id} cancelled.")

bunq_cli/commands/statements.py

@@ -0,0 +1,97 @@
+"""Account statement export commands."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from pathlib import Path
+
+import click
+
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "created", "date_start", "date_end", "format", "status"]
+
+
+@click.group()
+def statements() -> None:
+    """Export account statements."""
+
+
+@statements.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def list_statements(ctx: Context, account_id: int | None) -> None:
+    """List statement exports."""
+    client = ctx.get_client()
+    data = client.list_statements(account_id=account_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@statements.command("create")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@click.option("--from", "date_start", required=True, type=click.DateTime(["%Y-%m-%d"]), help="Start date (YYYY-MM-DD).")
+@click.option("--to", "date_end", required=True, type=click.DateTime(["%Y-%m-%d"]), help="End date (YYYY-MM-DD).")
+@click.option(
+    "--format",
+    "statement_format",
+    type=click.Choice(["CSV", "PDF", "MT940"], case_sensitive=False),
+    default="CSV",
+    help="Statement format (default: CSV).",
+)
+@click.option(
+    "--regional-format",
+    type=click.Choice(["EUROPEAN", "UK_US"], case_sensitive=False),
+    default="EUROPEAN",
+    help="CSV separator style: EUROPEAN (;) or UK_US (,). Only used for CSV.",
+)
+@pass_context
+def create_statement(
+    ctx: Context,
+    account_id: int | None,
+    date_start: datetime,
+    date_end: datetime,
+    statement_format: str,
+    regional_format: str,
+) -> None:
+    """Request a statement export. Download it with 'statements download'."""
+    statement_format = statement_format.upper()
+    client = ctx.get_client()
+    statement_id = client.create_statement(
+        statement_format=statement_format,
+        date_start=date_start.strftime("%Y-%m-%d"),
+        date_end=date_end.strftime("%Y-%m-%d"),
+        regional_format=regional_format.upper() if statement_format == "CSV" else None,
+        account_id=account_id,
+    )
+    if not ctx.quiet:
+        click.echo(f"Statement export created (ID: {statement_id}).")
+
+
+@statements.command("download")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@click.option("-o", "--output-file", type=click.Path(path_type=Path, dir_okay=False), required=True, help="File to write the statement to.")
+@pass_context
+def download_statement(ctx: Context, id: int, account_id: int | None, output_file: Path) -> None:
+    """Download a statement export."""
+    client = ctx.get_client()
+    if ctx.all_profiles:
+        if "{profile}" not in str(output_file):
+            raise click.UsageError("With --all-profiles, put {profile} in the output file name.")
+        output_file = Path(str(output_file).replace("{profile}", ctx.profile_name))
+    output_file.write_bytes(client.download_statement(id, account_id=account_id))
+    if not ctx.quiet:
+        click.echo(f"Statement saved to {output_file}.")
+
+
+@statements.command("delete")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def delete_statement(ctx: Context, id: int, account_id: int | None) -> None:
+    """Delete a statement export."""
+    client = ctx.get_client(write=True)
+    client.delete_statement(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"Statement {id} deleted.")