View Source Dnsimple.Tlds (dnsimple v4.0.0)

Provides functions to interact with the TLD endpoints.

See:

https://developer.dnsimple.com/v2/tlds/

Summary

Functions

get_tld(client, tld, options \\ [])

Returns a TLD.

get_tld_extended_attributes(client, tld, options \\ [])

Returns the extended attributes for a TLD.

list_tlds(client, options \\ [])

Returns the lists of DNSimple supported TLDs.

Functions

get_tld(client, tld, options \\ [])

@spec get_tld(Dnsimple.Client.t(), String.t(), Keyword.t()) ::
  {:ok | :error, Dnsimple.Response.t()}

Returns a TLD.

See:

https://developer.dnsimple.com/v2/tlds/#getTld

Examples

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Tlds.get_tld(client, "com")

get_tld_extended_attributes(client, tld, options \\ [])

@spec get_tld_extended_attributes(Dnsimple.Client.t(), String.t(), Keyword.t()) ::
  {:ok | :error, Dnsimple.Response.t()}

Returns the extended attributes for a TLD.

See:

https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes

Examples

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Tlds.get_tld_extended_attributes(client, "com")

list_tlds(client, options \\ [])

@spec list_tlds(Dnsimple.Client.t(), Keyword.t()) ::
  {:ok | :error, Dnsimple.Response.t()}

Returns the lists of DNSimple supported TLDs.

See:

https://developer.dnsimple.com/v2/tlds/#listTlds

Examples

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Tlds.list_tlds(client)
{:ok, response} = Dnsimple.Tlds.list_tlds(client, page: 2, per_page: 10)
{:ok, response} = Dnsimple.Tlds.list_tlds(client, sort: "tlds:desc")