# Changelog All notable changes to this project will be documented in this file. Dates are in UTC and are taken from the Git commit history. Versions are derived from tags and version-bump commits in `mix.exs`. ## [unreleased] ## [0.4.2] - 2025-12-04 ### Fixed - Handle Cloudflare DNS create error code `81058` (duplicate record) the same as `81057`, ensuring duplicate record attempts return `:already_exists`/`:already_created`. ## [0.4.0] - 2025-11-30 ### Added - Added shared type aliases plus a `CloudflareApi.Typespecs` macro that automatically injects default specs into every endpoint module, ensuring the entire library now exposes dialyzer-friendly types without hand-written annotations for each file. - Added a global doctest suite (with a default Tesla mock) so `mix test` now exercises the inline examples for every `CloudflareApi.*` module. - Added moduledocs/function docs (with inline examples) across the Cloudflare endpoint wrappers and a helper script (`script/add_endpoint_docs.exs`) so future modules can stay consistently documented. - Pay-Per-Crawl configuration + Stripe helpers, SecurityTxt, Tseng abuse report processing, WARP Teams device override codes, and Workers Pipelines (legacy + v1) modules with comprehensive tests to clear the remaining tags from `FULL_IMPLEMENTATION_PROGRESS.md`. - Hand-written modules for Cloudflare Accounts and Worker Routes endpoints, plus a progress log (`FULL_IMPLEMENTATION_PROGRESS.md`) that tracks manual coverage of the OpenAPI spec. - Zone Lockdown, Zone Rate Plans, Zone Rulesets, Zone Settings, Zone Snippets, Zone Subscription, and zone-level Access Applications modules (each with matching ExUnit coverage) to keep knocking items off `FULL_IMPLEMENTATION_PROGRESS.md`. - Zone Zero Trust organization, Brand Protection, BRAPI, Domain Search, DOS Flowtrackd, Logo Match, and mTLS Certificate Management modules (with comprehensive tests) so the next OpenAPI tag group is fully covered. - Added zone-level Access groups, identity providers, mTLS authentication, policies, service tokens, short-lived certificate CAs, and Authenticated Origin Pull helpers so the remaining Access/AOP rows in `FULL_IMPLEMENTATION_PROGRESS.md` now have documented wrappers and tests. - Added Keys (Workers telemetry), Leaked Credential Checks, Lists, Live Streams, Livestream Analytics, load balancer modules (healthcheck events, monitors, pools, regions, zone balancers), Logcontrol CMB config, zone/account Logpush jobs, Logs Received, Magic WAN app/connector/tunnel wrappers, Magic Network Monitoring + PCAP helpers, the full Magic Sites surface (sites, ACLs, app configs, LAN/WAN, NetFlow, static routes), R2 maintenance/namespaces, Managed Transforms, Meetings, and misc categories with comprehensive ExUnit coverage to keep the progress log moving down the OpenAPI tag list. - ExUnit coverage for the new Argo analytics, Smart Routing, AutoRAG, attacker, and audit log wrappers to keep recent modules guarded by tests. - AutoRAG collection management and search helpers to round out the initial AutoRAG surface area. - Automatic SSL/TLS, Page Rules settings, and BinDB helpers to extend coverage into SSL settings and Cloudforce One binary analysis workflows. - Bot Settings, Botnet Threat Feed, and Build Tokens modules with matching tests to continue the march across the Cloudflare tag list. - Builds, CNIs, and Cache Reserve Clear wrappers plus tests so Workers build introspection, interconnects, and Smart Shield jobs are now covered. - Calls apps, TURN keys, and Magic Catalog Sync helpers with full test coverage to keep expanding account-level management APIs. - Cloudflare IPs, Images, and Images Keys modules (with multipart upload handling) so media workflows and IP listings are represented in the wrapper. - Images variants, Cloudflare Tunnels, tunnel configuration, connectivity services, content scanning, and country helpers with tests to keep the manual rollout moving. - Custom hostname fallback/origin, custom hostname CRUD/cert helpers, custom origin trust stores, custom SSL configs, credential management, custom pages (zone/account), D1 database helpers, and custom indicator feeds to expand coverage across TLS, Workers storage, and intel APIs. - DCV Delegation, DEX Remote Commands, and DEX Synthetic Application Monitoring modules with comprehensive tests, including binary download handling for command artifacts. - DLP Datasets and DLP Document Fingerprints helpers, covering CRUD flows plus binary and multipart uploads for dataset versions and document fingerprints. - DLP Email account-mapping/rule management plus DLP entry helpers (custom, predefined, and integration variants) so the DLP surface is largely covered. - DLP Profiles and DLP Settings modules, handling profile CRUD/config endpoints and account-level limits/pattern validation/payload log APIs. - DLS Regional Services and DNS Analytics wrappers so regional hostname management and DNS analytics reports are available with tests. - DNS Firewall cluster management plus DNS Firewall analytics modules to cover firewall CRUD/reverse DNS and analytics reporting. - DNS internal views and DNS settings (zone/account) modules to wrap the remaining DNS settings endpoints with tests. - DNSSEC helpers plus Cloudforce One dataset CRUD, continuing the march through the remaining DNS/Dataset tags in the progress plan. - Dataset populate helper and Workers Observability destinations endpoints so Cloudforce One batch jobs and logging destinations are covered. - Device DEX tests and Device Managed Networks modules to round out the remaining device-tagged endpoints. - Device posture integrations and rules modules, keeping the Device section in `FULL_IMPLEMENTATION_PROGRESS.md` current. - Devices module (covering device settings policies, split tunnel lists, revoke/unrevoke, override codes, certificates) plus Devices Resilience helpers for the global WARP override. - Diagnostics traceroute helper plus domain history and domain intelligence modules to close out the intel-related tags. - Durable Objects namespace list/object helpers and email routing destination address CRUD, continuing the march across the remaining tags. - Email routing rules and settings modules (including catch-all + DNS toggles) to round out the email routing surface. - Email Security investigation endpoints and Email Security settings (allow, block, trusted domains, impersonation registry) now have wrappers and tests. - Endpoint health checks and build-trigger environment variables helpers, covering the diagnostics and environment variable tags. - Event (Cloudforce One) and Feedback modules to support event analytics plus bot-management feedback reporting. - Filters module for zone-level firewall filters, including query helpers and tests for bulk and single filter CRUD endpoints. - Firewall Rules module spanning list/create/update/delete plus priority helpers, including tests for bulk id handling and delete cascades. - Gateway CA module for Access SSH certificate authorities, covering list/create/delete flows and associated tests. - GitHub integration autofill, Health Checks (including Smart Shield + preview), Hyperdrive configs, and IP Access rules (user/zone/account) modules, each with request/response coverage and Tesla-based tests. - IP Address Management modules for address maps, prefixes (plus BGP, delegations, leases, dynamic advertisement, LOA download), bringing the addressing surface in line with the OpenAPI spec. - Added service bindings, IP intel/list lookups, Cloudforce One indicators & indicator types, infrastructure targets, Instant Logs jobs, interconnects, and Keyless SSL wrappers so the networking/Cloudforce One sections track the spec. - MCP portal + server management, Magic Interconnects, and the notification alerting surface (alert types, history, delivery eligibility, silences, PagerDuty destinations, policies, and webhooks) so Access AI Controls and Alerting tags are now represented with tested modules. - Observatory speed tests, Magic WAN on-ramps, organization/member helpers, Origin CA + post-quantum settings, Page Rules & Page Shield, plus Pages build cache/deployment wrappers to continue chipping away at the tag list with comprehensive ExUnit coverage. - Passive DNS lookups, per-hostname TLS + authenticated origin pulls, physical device + Realtime Kit preset helpers, Cloudforce One PIR, telemetry query, Queue/event subscription management, and R2 account/bucket coverage so the next set of tags have thin wrappers and tests. - R2 catalog + Super Slurper management plus the first wave of Radar analytics modules (AI Bots, AI Inference, AS112, annotations, autonomous systems, BGP, bots, and certificate transparency) so the Radar tag family now has tested entry points. - Added Radar DNS, datasets, domain ranking, email routing/security, geolocation, HTTP, IP lookup, internet service ranking, and Layer 3 attack helpers to keep expanding the Radar footprint with verified request/response coverage. - Layer 7 attacks, leaked credential checks, locations, NetFlows, origins, quality, robots.txt, search, TCP resets/timeouts, and TLD metadata wrappers finish another slice of Radar analytics with dedicated tests. - Added verified bots, web crawlers, traffic anomalies, zone rate limits, Realtime Kit recordings, registrar domains, device registrations, build repo connections, Cloudforce One RFI, and resource sharing modules plus tests to keep the non-Radar tags moving forward. - Resources catalog, SSL verification + mode recommendation, account SSO connectors, Cloudforce One scans, schema validation (schemas + settings), and Secondary DNS (ACL/peer/primary zone) helpers round out the next batch with associated ExUnit coverage. - Added Pages Domains/Projects, Secondary DNS secondary zone + TSIG, Secrets Store, Security Center Insights, Sessions, Settings, Sinkhole Config, and Slots modules—each with matching tests—to continue driving the OpenAPI tag list toward completion. - Added Smart Shield/Tiered Cache, Spectrum analytics/applications, and a swath of Stream helpers (audio tracks, live inputs, MP4 downloads, signing keys, subtitles/captions, clipping) so caching + media endpoints now have thin wrappers and deterministic tests. - Rounded out the remaining Stream layer (videos, watermarks, webhooks) plus R2 table maintenance/management, Cloudforce One tag/category/target industry helpers, tenant metadata, and classic Argo Tiered Caching so the next slice of the OpenAPI backlog is covered with docs and tests. - Implemented Token Validation configs/rules, Total TLS, build Triggers, tunnel routing + virtual networks, Turnstile, URL Normalization, and both generations of URL Scanner so the next sequence of security/networking tags are fully wrapped with ExUnit coverage. - Added Universal SSL settings plus a suite of user-scoped modules (profile, tenants, API tokens, UA blocking, billing history/profile, subscriptions, account memberships, invites, orgs) with matching tests to keep chipping away at the remaining user/zone settings list. - Covered telemetry `Values`, Vectorize v2 + beta endpoints, Workers versions, WAF overrides/packages/groups/rules, WARP change events, and WHOIS lookups so the analytics/security backlog keeps shrinking with documented wrappers and ExUnit coverage. - Added Waiting Room, Web Analytics, Web3 Hostname, Webhooks, Worker Account Settings, Worker Cron Trigger, and Worker Deployments modules (with matching tests) to keep chipping away at the next section of `FULL_IMPLEMENTATION_PROGRESS.md`. - Implemented Worker Domain, Worker Environment, Worker Script, Worker Subdomain, Worker Tail Logs, Workers (service CRUD/build metadata), and Workers AI modules, each with accompanying ExUnit coverage to extend the Workers surface in the progress log. - Added Workers AI Automatic Speech Recognition, Dumb Pipe, Finetune, Image Classification, Object Detection, Summarization, and Text Classification wrappers (with tests) to keep the Workers AI tag family on pace with `FULL_IMPLEMENTATION_PROGRESS.md`. - Added Workers AI Text Embeddings/Generation/Text-to-* modules, Workers AI Translation, and the storage/control plane helpers for Workers KV namespaces plus Workers for Platforms, all with coverage to keep the spec tracker moving. - Workflows, Zaraz, Zero Trust connectivity settings, PAC files, application/type mappings, categories, and locations now have dedicated modules and tests, continuing the steady march through the remaining tags in `FULL_IMPLEMENTATION_PROGRESS.md`. - Completed the next Zero Trust slice: proxy endpoints, gateway rules, hostname routes, risk scoring (behaviors/summary/user reset), risk scoring integrations, and SSH settings—each with thin modules and deterministic tests. - Added Zero Trust subnets, accounts (device settings + gateway config/logging), application review status, certificates, lists, organization (plus DoH/revoke), and seats coverage with matching tests to keep whittling down the remaining Zero Trust tags. ### Changed - Reverted the automatic OpenAPI module generation approach in favour of explicit modules similar to the original DNS/Zone helpers. Updated the README and top-level moduledoc to explain the manual rollout plan. - Polished the `CloudflareApi` moduledoc and client helper documentation, adding tested examples and clarifying how to construct and reuse clients. - Added a Livebook walkthrough (`livebooks/zones_dns_settings.livemd`) that exercises zone, DNS record, and DNS settings read/write flows for interactive experimentation. - Updated development-time dependencies (`ex_doc`, `jason` and their formatter stack) to the latest Hex releases. - Add a dedicated `build` job to the CI workflow that compiles the project, runs `mix hex.build`, and uploads the resulting Hex tarball as a GitHub Actions artifact. - Add a tag-triggered `release` job that re-builds the Hex tarball for version tags (e.g. `v0.3.0`) and creates a GitHub release with the package attached. - Centralized the GitHub Actions Elixir/OTP version matrix into top-level workflow variables so supported versions are declared once. - Restored the Elixir-based `script/update_version.exs` helper and added a `mix update_version` alias so release bumps are easy to invoke. - Added debug logging inside `CloudflareApi.Cache.expire/1` so forced expirations emit a trace when an entry is touched or when nothing matches the hostname. ### Fixed - Implement `CloudflareApi.Cache.expire/1` so forced expirations update timestamps instead of requiring manual state tweaks, plus document/test the behaviour (no-op on missing hostnames). - Ensure `CloudflareApi.Cache.includes?/2` honours the `:even_if_expired` flag by returning booleans instead of cached structs, and update the docs/tests to cover missing + expired hostnames. - Ensure `CloudflareApi.Cache.get/1` and `get/2` return `nil` for missing hostnames (while preserving the `:even_if_expired` escape hatch) and update cache tests so expiry semantics match the documented behaviour. - Tighten doctest HTTP mocking by pattern matching on `%Tesla.Env{}` to keep type checks quiet while preserving the existing doctest behaviour. - Removed the deprecated `CloudflareApi.Utils.is_uuid?/1` and `is_uuid_or_nil?/1` aliases now that `uuid?/1` helpers cover the same behaviour, satisfying credo's predicate naming rule. - Normalized large numeric literals in the radar, botnet feed, keyless SSL, and IP address management tests to use underscore separators so credo's readability checks pass without changing the underlying values. - Applied credo-driven refactors (swapping single-branch `cond` blocks for `if`, simplifying DNS record existence helpers, and using `Enum.map_join/3` in string utils) to keep the helpers more idiomatic and efficient. - Tightened dialyzer coverage by enhancing the auto-generated specs, adding manual specs for binary/multipart helpers, and teaching dialyzer about Mix/IEx dependencies so `mix dialyzer` can run without spurious warnings. - Added explicit typespecs across the DNS modules (records, settings, firewall, analytics, and helpers) so their return types are documented without relying solely on the automatic spec generator. - Fixed the CI workflow by inlining the Elixir/OTP matrices and removing the unsupported `cache` input from `erlef/setup-beam`, eliminating the parsing and warning noise on GitHub Actions. ## [0.3.0] - 2025-11-28 Changes since `v0.2.3`. ### Added - Added extensive module and function documentation across the public API, including `CloudflareApi.DnsRecords`, `CloudflareApi.Zones`, `CloudflareApi.DnsRecord`, cache modules, and utility modules, to improve the generated HexDocs. - Introduced a mix task `mix cloudflare_api.fetch_openapi` for fetching and caching Cloudflare's official OpenAPI schema under `priv/cloudflare_api/openapi.json`. - Significantly expanded the automated test suite with high‑coverage ExUnit tests for DNS records, zones, utilities, cache behaviour, and the top-level client. - Enhanced the README with more complete usage documentation and examples. - Added local tooling/docs for working with AI assistants (e.g. `CLAUDE.md` and related configuration files). ### Changed - Aligned DNS record and zone listing functions with the official Cloudflare OpenAPI specification, including query parameter handling and response decoding. - Introduced project-wide automatic formatting and adjusted existing modules and tests to match the formatter configuration. - Upgraded core dependencies (such as `tesla`, `jason`, `ex_doc`, and tooling libraries) to more recent versions. ### Fixed - Addressed a set of low-effort Credo warnings and minor style issues across implementation and test modules. ## [0.2.3] - 2024-08-28 Patch releases in the `0.2.x` series focused on DNS TTL correctness and small quality-of-life improvements. ### Changed - Switched DNS record TTL handling from string to integer to better reflect the underlying Cloudflare API and avoid ambiguity when encoding requests (`0.2.2`). ### Fixed - Fixed handling of automatic TTL in `CloudflareApi.DnsRecord` so records correctly respect Cloudflare's automatic TTL behaviour (`0.2.1` / `0.2.2`). - Restored Cloudflare's automatic TTL when TTL is not specified, ensuring the library no longer sends invalid TTL values on create/update calls (`0.2.3`). - Quieted a compiler warning on an unused variable and corrected a misleading comment in the codebase. ## [0.2.0] - 2024-08-28 ### Changed - Bumped the library version to `0.2.0` after stabilising TTL-related changes and minor cleanups. - Updated the README to reflect the newer API surface and behaviour. ## [0.1.0] - 2024-08-28 ### Fixed - Worked around a change in the Cloudflare API that no longer accepted a TTL value of `1`, adjusting the library to send acceptable TTL values while preserving previous semantics as closely as possible. - Corrected an inaccurate comment and performed minor code cleanups. ## [0.0.5] - 2022-04-06 ### Added - Added `list_for_host_domain` variants to `CloudflareApi.DnsRecords`, allowing callers to provide separate `host` and `domain` parts and letting the library construct the fully-qualified hostname. ### Changed - Bumped the library version to `v0.0.5`. ## [0.0.4] - 2022-04-06 Initial early release series. ### Added - Generated the initial project skeleton and implemented the first pass of the Cloudflare API wrapper, including DNS record operations and supporting utilities. - Integrated `ex_doc` and added enough description/metadata to publish the package on Hex. - Added an initial Livebook notebook for interactive examples. ### Changed - Removed an accidental dependency on `Bonny` and pruned unused password-related helpers to keep the dependency set minimal.