View Source Vercel.Domains (Vercel v0.2.0)
Link to this section Summary
Functions
Allows to purchase the specified domain.
Get information for a single domain in an account or team.
Retrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided.
Check the price to purchase a domain and how long a single purchase period is.
Check if a domain name is available for purchase.
Link to this section Functions
@spec buy(params, opts) :: {:ok, map()} | {:error, any()} when params: %{ :name => String.t(), optional(:expectedPrice) => number(), optional(:renew) => boolean() }, opts: %{optional(:teamId) => String.t()}
Allows to purchase the specified domain.
@spec info(String.t(), params) :: {:ok, map()} | {:error, any()} when params: %{optional(:teamId) => String.t()}
Get information for a single domain in an account or team.
@spec list(params) :: {:ok, map()} | {:error, any()} when params: %{ optional(:limit) => integer(), optional(:since) => integer(), optional(:teamId) => String.t(), optional(:until) => integer() }
Retrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided.
@spec price(params) :: {:ok, map()} | {:error, any()} when params: %{ :name => String.t(), optional(:teamId) => String.t(), optional(:type) => String.t() }
Check the price to purchase a domain and how long a single purchase period is.
@spec status(params) :: {:ok, map()} | {:error, any()} when params: %{:name => String.t(), optional(:teamId) => String.t()}
Check if a domain name is available for purchase.