bunq-cli 0.2.0__py3-none-any.whl

bunq_cli/commands/accounts.py

@@ -0,0 +1,37 @@
+"""Accounts commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "description", "type", "currency", "balance", "iban", "status"]
+
+
+@click.group()
+def accounts() -> None:
+    """Manage monetary accounts."""
+
+
+@accounts.command("list")
+@click.option("--include-inactive", is_flag=True, help="Include closed accounts.")
+@pass_context
+def list_accounts(ctx: Context, include_inactive: bool) -> None:
+    """List all monetary accounts."""
+    client = ctx.get_client()
+    data = client.list_accounts()
+    if not include_inactive:
+        data = [a for a in data if a.get("status") == "ACTIVE"]
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@accounts.command("get")
+@click.argument("id", type=int)
+@pass_context
+def get_account(ctx: Context, id: int) -> None:
+    """Get a single monetary account by ID."""
+    client = ctx.get_client()
+    data = client.get_account(id)
+    echo_output(data, fmt=ctx.output_format)

bunq_cli/commands/bunqme.py

@@ -0,0 +1,75 @@
+"""bunq.me payment link commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "created", "status", "amount", "currency", "description", "url"]
+
+
+@click.group()
+def bunqme() -> None:
+    """Manage bunq.me payment links."""
+
+
+@bunqme.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def list_tabs(ctx: Context, account_id: int | None) -> None:
+    """List bunq.me payment links."""
+    client = ctx.get_client()
+    data = client.list_bunqme_tabs(account_id=account_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@bunqme.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_tab(ctx: Context, id: int, account_id: int | None) -> None:
+    """Get a single bunq.me payment link."""
+    client = ctx.get_client()
+    data = client.get_bunqme_tab(id, account_id=account_id)
+    echo_output(data, fmt=ctx.output_format)
+
+
+@bunqme.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 request (e.g., 15.00).")
+@click.option("--currency", default="EUR", help="Currency code (default: EUR).")
+@click.option("--description", required=True, help="Description shown to the payer.")
+@click.option("--redirect-url", default=None, help="URL to send the payer to after paying.")
+@pass_context
+def create_tab(
+    ctx: Context,
+    account_id: int | None,
+    amount: str,
+    currency: str,
+    description: str,
+    redirect_url: str | None,
+) -> None:
+    """Create a bunq.me payment link."""
+    client = ctx.get_client(write=True)
+    data = client.create_bunqme_tab(
+        amount=amount,
+        currency=currency,
+        description=description,
+        redirect_url=redirect_url,
+        account_id=account_id,
+    )
+    echo_output(data, fmt=ctx.output_format)
+
+
+@bunqme.command("cancel")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def cancel_tab(ctx: Context, id: int, account_id: int | None) -> None:
+    """Cancel a bunq.me payment link."""
+    client = ctx.get_client(write=True)
+    client.cancel_bunqme_tab(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"bunq.me link {id} cancelled.")

bunq_cli/commands/callbacks.py

@@ -0,0 +1,122 @@
+"""Callbacks (notification filter) 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", "category", "notification_target"]
+
+CATEGORIES = [
+    "MUTATION",
+    "PAYMENT",
+    "INSTANT_PAYMENT",
+    "PAYMENT_DELAYED",
+    "PAYMENT_SUSPENDED",
+    "PAYMENT_UPDATED",
+    "DRAFT_PAYMENT",
+    "REQUEST",
+    "SCHEDULE_RESULT",
+    "SCHEDULE_STATUS",
+    "IDEAL",
+    "SOFORT",
+    "CARD_TRANSACTION_SUCCESSFUL",
+    "CARD_TRANSACTION_FAILED",
+    "CARD_TRANSACTION_UPDATED",
+    "CARD_TRANSACTION_REFUND",
+    "CARD_TRANSACTION_TOKENIZED",
+    "CARD_DYNAMIC_CURRENCY_CONVERSION_WARNING",
+    "CARD_EXPIRY",
+    "CARD_REPLACEMENT",
+    "CARD_COUNTRY_PERMISSION",
+    "CARD_TOKENIZATION",
+    "MASTERCARD_IDENTITY_CHECK",
+    "MONETARY_ACCOUNT_BALANCE",
+    "MONETARY_ACCOUNT_JOINT",
+    "CO_OWNER_INVITE",
+    "APPROVAL_REQUEST_USER",
+    "APPROVAL_REQUEST_MONETARY_ACCOUNT",
+    "WHITELIST",
+    "WHITELIST_RESULT",
+    "TAB_RESULT",
+    "BUNQME_TAB",
+    "BUNQME_TAB_RESULT_INQUIRY",
+    "BUNQME_TAB_RESULT_RESPONSE",
+    "OAUTH",
+]
+
+
+@click.group()
+def callbacks() -> None:
+    """Manage notification filters (webhooks)."""
+
+
+@callbacks.command("list")
+@pass_context
+def list_callbacks(ctx: Context) -> None:
+    """List all notification filters."""
+    client = ctx.get_client()
+    data = client.list_callbacks()
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@callbacks.command("create")
+@click.option("--url", required=True, help="Callback URL.")
+@click.option(
+    "--category",
+    "categories",
+    multiple=True,
+    type=click.Choice(CATEGORIES, case_sensitive=False),
+    required=True,
+    help="Event category (can be specified multiple times).",
+)
+@pass_context
+def create_callback(ctx: Context, url: str, categories: tuple[str, ...]) -> None:
+    """Create notification filters for one or more event categories."""
+    if not url.lower().startswith("https://"):
+        raise click.BadParameter("bunq requires an HTTPS callback URL.", param_hint="--url")
+    client = ctx.get_client(write=True)
+    data = client.create_callback(url, [c.upper() for c in categories])
+    if not ctx.quiet:
+        click.echo(f"Created {len(categories)} notification filter(s).")
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@callbacks.command("delete")
+@yes_option
+@pass_context
+def delete_callbacks(ctx: Context, yes: bool) -> None:
+    """Remove all notification filters."""
+    client = ctx.get_client(write=True)
+    ctx.confirm("Remove ALL notification filters?", yes)
+    client.delete_all_callbacks()
+    if not ctx.quiet:
+        click.echo("All notification filters removed.")
+
+
+@callbacks.command("failures")
+@pass_context
+def list_failures(ctx: Context) -> None:
+    """List callbacks that failed after all retries."""
+    client = ctx.get_client()
+    data = client.list_callback_failures()
+    echo_output(
+        data,
+        fmt=ctx.output_format,
+        columns=["id", "created", "category", "event_type", "object_id", "response_code"],
+    )
+
+
+@callbacks.command("retry")
+@click.argument("ids", type=int, nargs=-1, required=True)
+@pass_context
+def retry_failures(ctx: Context, ids: tuple[int, ...]) -> None:
+    """Retry failed callbacks by failure ID (max 100)."""
+    if len(ids) > 100:
+        raise click.BadParameter("At most 100 IDs can be retried at once.", param_hint="IDS")
+    client = ctx.get_client(write=True)
+    client.retry_callback_failures(list(ids))
+    if not ctx.quiet:
+        click.echo(f"Retrying {len(ids)} callback(s).")

bunq_cli/commands/cards.py

@@ -0,0 +1,122 @@
+"""Cards commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "type", "product_type", "status", "second_line", "expiry_date", "card_limit"]
+
+
+@click.group()
+def cards() -> None:
+    """Manage cards."""
+
+
+@cards.command("list")
+@pass_context
+def list_cards(ctx: Context) -> None:
+    """List all cards."""
+    client = ctx.get_client()
+    data = client.list_cards()
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@cards.command("get")
+@click.argument("id", type=int)
+@pass_context
+def get_card(ctx: Context, id: int) -> None:
+    """Get a single card by ID."""
+    client = ctx.get_client()
+    data = client.get_card(id)
+    echo_output(data, fmt=ctx.output_format)
+
+
+@cards.command("freeze")
+@click.argument("id", type=int)
+@pass_context
+def freeze_card(ctx: Context, id: int) -> None:
+    """Temporarily freeze a card."""
+    client = ctx.get_client(write=True)
+    client.update_card(id, status="DEACTIVATED")
+    if not ctx.quiet:
+        click.echo(f"Card {id} frozen.")
+
+
+@cards.command("unfreeze")
+@click.argument("id", type=int)
+@pass_context
+def unfreeze_card(ctx: Context, id: int) -> None:
+    """Unfreeze a frozen card."""
+    client = ctx.get_client(write=True)
+    client.update_card(id, status="ACTIVE")
+    if not ctx.quiet:
+        click.echo(f"Card {id} unfrozen.")
+
+
+@cards.command("update")
+@click.argument("id", type=int)
+@click.option("--daily-limit", type=float, default=None, help="Daily spending limit (e.g., 500.00).")
+@click.option("--atm-limit", type=float, default=None, help="Daily ATM withdrawal limit (e.g., 250.00).")
+@click.option("--country-permission", "countries", multiple=True, help="Country code the card may be used in (repeatable, replaces the current list).")
+@click.option("--change-pin", is_flag=True, help="Prompt for a new PIN code.")
+@pass_context
+def update_card(
+    ctx: Context,
+    id: int,
+    daily_limit: float | None,
+    atm_limit: float | None,
+    countries: tuple[str, ...],
+    change_pin: bool,
+) -> None:
+    """Update card settings."""
+    from bunq.sdk.model.generated.object_ import AmountObject, CardCountryPermissionObject
+
+    kwargs = {}
+    if daily_limit is not None:
+        kwargs["card_limit"] = AmountObject(f"{daily_limit:.2f}", "EUR")
+    if atm_limit is not None:
+        kwargs["card_limit_atm"] = AmountObject(f"{atm_limit:.2f}", "EUR")
+    if countries:
+        kwargs["country_permission"] = [
+            CardCountryPermissionObject(country=c.upper()) for c in countries
+        ]
+    if change_pin:
+        kwargs["pin_code"] = click.prompt("New PIN", hide_input=True, confirmation_prompt=True)
+
+    if not kwargs:
+        raise click.ClickException(
+            "No updates specified. Use --daily-limit, --atm-limit, --country-permission or --change-pin."
+        )
+
+    client = ctx.get_client(write=True)
+    data = client.update_card(id, **kwargs)
+    echo_output(data, fmt=ctx.output_format)
+
+
+TRANSACTION_COLUMNS = ["id", "created", "amount", "currency", "merchant", "card_id", "decision", "status"]
+
+
+@cards.command("transactions")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@click.option("--count", type=int, default=25, help="Number of results.")
+@click.option("--older-id", type=int, default=None, help="Cursor: fetch results older than this ID.")
+@pass_context
+def list_transactions(ctx: Context, account_id: int | None, count: int, older_id: int | None) -> None:
+    """List card transactions (authorisations, declines, refunds)."""
+    client = ctx.get_client()
+    data = client.list_card_transactions(account_id=account_id, count=count, older_id=older_id)
+    echo_output(data, fmt=ctx.output_format, columns=TRANSACTION_COLUMNS)
+
+
+@cards.command("transaction")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def get_transaction(ctx: Context, id: int, account_id: int | None) -> None:
+    """Get a single card transaction."""
+    client = ctx.get_client()
+    data = client.get_card_transaction(id, account_id=account_id)
+    echo_output(data, fmt=ctx.output_format)

bunq_cli/commands/drafts.py

@@ -0,0 +1,79 @@
+"""Draft payment commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "created", "status", "amount", "currency", "counterparty", "description"]
+
+
+@click.group("draft-payments")
+def drafts() -> None:
+    """Manage draft payments (approved in the bunq app)."""
+
+
+@drafts.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def list_drafts(ctx: Context, account_id: int | None) -> None:
+    """List draft payments."""
+    client = ctx.get_client()
+    data = client.list_draft_payments(account_id=account_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@drafts.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_draft(ctx: Context, id: int, account_id: int | None) -> None:
+    """Get a single draft payment."""
+    client = ctx.get_client()
+    data = client.get_draft_payment(id, account_id=account_id)
+    echo_output(data, fmt=ctx.output_format)
+
+
+@drafts.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.")
+@pass_context
+def create_draft(
+    ctx: Context,
+    account_id: int | None,
+    amount: str,
+    currency: str,
+    recipient_iban: str,
+    recipient_name: str,
+    description: str,
+) -> None:
+    """Create a draft payment. It is only executed after approval in the bunq app."""
+    client = ctx.get_client(write=True)
+    draft_id = client.create_draft_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"Draft payment created (ID: {draft_id}). Approve it in the bunq app.")
+
+
+@drafts.command("reject")
+@click.argument("id", type=int)
+@click.option("--account", "account_id", type=int, default=None, help="Monetary account ID (default: primary).")
+@pass_context
+def reject_draft(ctx: Context, id: int, account_id: int | None) -> None:
+    """Reject (withdraw) a pending draft payment."""
+    client = ctx.get_client(write=True)
+    client.reject_draft_payment(id, account_id=account_id)
+    if not ctx.quiet:
+        click.echo(f"Draft payment {id} rejected.")

bunq_cli/commands/events.py

@@ -0,0 +1,37 @@
+"""Event (activity feed) commands."""
+
+from __future__ import annotations
+
+import click
+
+from bunq_cli.main import Context, pass_context
+from bunq_cli.output import echo_output
+
+LIST_COLUMNS = ["id", "created", "action", "object_type", "object_id", "account_id", "status"]
+
+
+@click.group()
+def events() -> None:
+    """View the account activity feed."""
+
+
+@events.command("list")
+@click.option("--account", "account_id", type=int, default=None, help="Only events for this monetary account.")
+@click.option("--count", type=int, default=25, help="Number of results.")
+@click.option("--older-id", type=int, default=None, help="Cursor: fetch results older than this ID.")
+@pass_context
+def list_events(ctx: Context, account_id: int | None, count: int, older_id: int | None) -> None:
+    """List recent events."""
+    client = ctx.get_client()
+    data = client.list_events(account_id=account_id, count=count, older_id=older_id)
+    echo_output(data, fmt=ctx.output_format, columns=LIST_COLUMNS)
+
+
+@events.command("get")
+@click.argument("id", type=int)
+@pass_context
+def get_event(ctx: Context, id: int) -> None:
+    """Get a single event, including the object it refers to."""
+    client = ctx.get_client()
+    data = client.get_event(id)
+    echo_output(data, fmt=ctx.output_format)

bunq_cli/commands/login.py

@@ -0,0 +1,131 @@
+"""Login and logout commands."""
+
+from __future__ import annotations
+
+import ipaddress
+from pathlib import Path
+
+import click
+
+from bunq_cli.client import create_context, current_user_name, destroy_context
+from bunq_cli.config import (
+    CONTEXTS_DIR,
+    load_config,
+    remove_profile,
+    resolve_profile,
+    save_config,
+    set_profile,
+    validate_profile_name,
+)
+from bunq_cli.main import Context, pass_context
+from bunq_cli.oauth import oauth_login
+
+
+def _validate_ips(ctx: click.Context, param: click.Parameter, value: tuple[str, ...]) -> list[str]:
+    for ip in value:
+        if ip != "*":
+            try:
+                ipaddress.ip_address(ip)
+            except ValueError:
+                raise click.BadParameter(f"{ip!r} is not an IP address or '*'.") from None
+    return list(value)
+
+
+def _validate_profile(ctx: click.Context, param: click.Parameter, value: str | None) -> str | None:
+    return validate_profile_name(value) if value else None
+
+
+def _contexts_dir() -> Path:
+    CONTEXTS_DIR.mkdir(parents=True, exist_ok=True)
+    try:
+        CONTEXTS_DIR.chmod(0o700)
+    except OSError:
+        pass
+    return CONTEXTS_DIR
+
+
+@click.command()
+@click.option("--profile", "profile_name", default=None, callback=_validate_profile, help="Profile name to store this login under (e.g. the client's name).")
+@click.option("--token", default=None, help="API key (skip OAuth and use this token directly).")
+@click.option("--sandbox", is_flag=True, help="Use the sandbox environment.")
+@click.option(
+    "--allowed-ip",
+    "allowed_ips",
+    multiple=True,
+    default=["*"],
+    show_default=True,
+    callback=_validate_ips,
+    help="IP address the API key may be used from (repeatable). With '*', bunq assigns "
+    "the IP you log in from, or allows any IP for wildcard API keys.",
+)
+@click.option("--read-only/--read-write", default=None, help="Block commands that change data for this profile.")
+@pass_context
+def login(
+    ctx: Context,
+    profile_name: str | None,
+    token: str | None,
+    sandbox: bool,
+    allowed_ips: list[str],
+    read_only: bool | None,
+) -> None:
+    """Log in to a bunq account and store it as a profile.
+
+    Without --token, opens your browser for OAuth authorization.
+    With --token, uses the API key directly.
+    """
+    sandbox = sandbox or ctx.sandbox
+    config = load_config(ctx.config_path)
+    profiles = config.get("profiles", {})
+    name = profile_name or ctx.profile
+    if name is None and profiles:
+        # Guessing could overwrite another client's login.
+        raise click.UsageError(
+            f"Pass --profile NAME (existing profiles: {', '.join(profiles)})."
+        )
+    name = validate_profile_name(name or "default")
+
+    if token is None:
+        token = oauth_login(sandbox=sandbox, config=config)
+
+    context_path = profiles.get(name, {}).get("context_path") or str(_contexts_dir() / f"{name}.conf")
+    create_context(
+        api_key=token,
+        context_path=Path(context_path).expanduser(),
+        sandbox=sandbox,
+        permitted_ips=allowed_ips,
+    )
+
+    config = set_profile(
+        config,
+        name,
+        context_path=context_path,
+        sandbox=sandbox,
+        display_name=current_user_name(),
+        read_only=read_only,
+    )
+    save_config(config, ctx.config_path)
+
+    if not ctx.quiet:
+        env_name = "sandbox" if sandbox else "production"
+        who = config["profiles"][name].get("display_name") or "unknown user"
+        click.echo(f"Logged in to bunq ({env_name}) as {who}, profile '{name}'.")
+
+
+@click.command()
+@click.option("--profile", "profile_name", default=None, help="Profile to log out (default: the selected profile).")
+@click.option("--all", "all_profiles", is_flag=True, help="Log out of every profile.")
+@pass_context
+def logout(ctx: Context, profile_name: str | None, all_profiles: bool) -> None:
+    """Close the session and remove a profile's stored credentials."""
+    config = load_config(ctx.config_path)
+    if all_profiles:
+        names = list(config.get("profiles", {}))
+    else:
+        names = [resolve_profile(config, profile_name or ctx.profile)[0]]
+
+    for name in names:
+        destroy_context(Path(config["profiles"][name]["context_path"]).expanduser())
+        config = remove_profile(config, name)
+        if not ctx.quiet:
+            click.echo(f"Logged out of profile '{name}'.")
+    save_config(config, ctx.config_path)