Current section

Files

Jump to
cloudflare_api lib cloudflare_api user_account_memberships.ex
Raw

lib/cloudflare_api/user_account_memberships.ex

defmodule CloudflareApi.UserAccountMemberships do
@moduledoc ~S"""
Manage user account memberships via `/memberships`.
"""
use CloudflareApi.Typespecs
@doc ~S"""
List user account memberships.
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.UserAccountMemberships.list(client, [])
{:ok, [%{"id" => "example"}]}
"""
def list(client, opts \\ []) do
c(client)
|> Tesla.get(with_query("/memberships", opts))
|> handle_response()
end
@doc ~S"""
Get user account memberships.
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.UserAccountMemberships.get(client, "membership_id", [])
{:ok, %{"id" => "example"}}
"""
def get(client, membership_id, opts \\ []) do
c(client)
|> Tesla.get(with_query(membership_path(membership_id), opts))
|> handle_response()
end
@doc ~S"""
Update user account memberships.
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.UserAccountMemberships.update(client, "membership_id", %{})
{:ok, %{"id" => "example"}}
"""
def update(client, membership_id, params) when is_map(params) do
c(client)
|> Tesla.put(membership_path(membership_id), params)
|> handle_response()
end
@doc ~S"""
Delete user account memberships.
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.UserAccountMemberships.delete(client, "membership_id")
{:ok, %{"id" => "example"}}
"""
def delete(client, membership_id) do
c(client)
|> Tesla.delete(membership_path(membership_id), body: %{})
|> handle_response()
end
defp membership_path(id), do: "/memberships/#{encode(id)}"
defp encode(value), do: value |> to_string() |> URI.encode_www_form()
defp with_query(path, []), do: path
defp with_query(path, opts), do: path <> "?" <> CloudflareApi.uri_encode_opts(opts)
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