[franciscbalint]

Summary

A full pass over every doc in the repo after #28, checked against the code.

• README / documentation.md
  • Security: where the key travels per API (validation API query/body, Inbox Placement Tester Authorization: Bearer, Warmup API-Key), https enforced on every base URL, redaction and key checks. The old text said api_key is always a query parameter.
  • New errors note (ZBClientException vs ZBApiException, status_code, unknown enum values).
  • Regions: file-based APIs always use bulkapi.zerobounce.net.
  • Email finder: first_name optional, use_post.
  • stream=True on every download example.
  • Other hosts: BULK_ROOT_URL and the https rule.
  • guess_format example crashed ("..." + response).
  • Development: install with [test] and the pinned ruff; lint and pytest commands; the live suite's real command. The old python -m tests output showed contradictory counts.
• AGENTS.md: all six offline suites, pinned ruff, every optional parameter, key placement per API, the https guard and regional warning, the redaction-outside-except pattern.
• CONTRIBUTING.md: branch from and PR against master (it said main), Conventional Commits, CHANGELOG entry, docs-only endpoints rule.
• SECURITY.md: current guidance (https enforced, Python 3.10+, query strings in logs, separate Warmup key, no HTTP debug logging).
• CHANGELOG.md: the missing [2.2.4] section (a CI-only release) and its compare link.
• Dockerfile: runs every offline suite (it ran only zero_bounce_test_case.py).
• tests/main.py: runs every offline suite, and no longer includes the live API suite, which called the real API whenever ZEROBOUNCE_API_KEY was set.
• pyproject.toml: keywords plus Documentation / Changelog / Issues URLs (shown on PyPI).
• ZeroBounce docstring: what it covers; ZeroBounceWarmup for Warmup.

Test plan

• ruff check src tests, python -m compileall -q src tests, python -m pytest (127 passed on Python 3.12 and 3.9)
• python -m tests runs the offline suites only
• Every Python example in README.md (32 blocks) and documentation.md (31 blocks) runs against the offline fakes, with no errors printed

🤖 Generated with Claude Code