Current section

Files

Jump to
cloudflare_api lib cloudflare_api dnssec.ex
Raw

lib/cloudflare_api/dnssec.ex

defmodule CloudflareApi.Dnssec do
@moduledoc ~S"""
DNSSEC helpers for `/zones/:zone_id/dnssec`.
"""
use CloudflareApi.Typespecs
@type client :: CloudflareApi.client()
@type zone_id :: CloudflareApi.id()
@type result :: CloudflareApi.result(term())
@doc ~S"""
Details dnssec.
Calls the Cloudflare API endpoint described in the moduledoc and
returns `{:ok, result}` on success or `{:error, reason}` when the request fails.
## Examples
iex> client = CloudflareApi.client("api-token")
iex> CloudflareApi.Dnssec.details(client, "zone_id")
{:ok, %{"id" => "example"}}
"""
@spec details(client(), zone_id()) :: result()
def details(client, zone_id) do
c(client)
|> Tesla.get(path(zone_id))
|> handle_response()
end
@doc ~S"""
Delete dnssec.
Calls the Cloudflare API endpoint described in the moduledoc and
returns `{:ok, result}` on success or `{:error, reason}` when the request fails.
## Examples
iex> client = CloudflareApi.client("api-token")
iex> CloudflareApi.Dnssec.delete(client, "zone_id")
{:ok, %{"id" => "example"}}
"""
@spec delete(client(), zone_id()) :: result()
def delete(client, zone_id) do
c(client)
|> Tesla.delete(path(zone_id), body: %{})
|> handle_response()
end
@doc ~S"""
Update dnssec.
Calls the Cloudflare API endpoint described in the moduledoc and
returns `{:ok, result}` on success or `{:error, reason}` when the request fails.
## Examples
iex> client = CloudflareApi.client("api-token")
iex> CloudflareApi.Dnssec.update(client, "zone_id", %{})
{:ok, %{"id" => "example"}}
"""
@spec update(client(), zone_id(), map()) :: result()
def update(client, zone_id, params) when is_map(params) do
c(client)
|> Tesla.patch(path(zone_id), params)
|> handle_response()
end
defp path(zone_id), do: "/zones/#{zone_id}/dnssec"
defp handle_response({:ok, %Tesla.Env{status: status, body: %{"result" => result}}})
when status in 200..299,
do: {:ok, result}
defp handle_response({:ok, %Tesla.Env{status: status, body: body}}) when status in 200..299,
do: {:ok, body}
defp handle_response({:ok, %Tesla.Env{body: %{"errors" => errors}}}), do: {:error, errors}
defp handle_response(other), do: {:error, other}
defp c(%Tesla.Client{} = client), do: client
defp c(fun) when is_function(fun, 0), do: fun.()
end