dnsimple v0.9.0 Dnsimple.Domains

The Domains module handles communication with the domain related methods of the DNSimple API.

See https://developer.dnsimple.com/v2/domains/

Summary

Functions

List all domains from the account. This function will automatically page through to the end of the list, returning all domain objects

PERMANENTLY deletes a domain from the account

Functions

all_domains(client, account_id, options \\ [])

Specs

all_domains(Dnsimple.Client.t, String.t | integer, Keyword.t) :: [Dnsimple.Domain.t]

List all domains from the account. This function will automatically page through to the end of the list, returning all domain objects.

create_domain(client, account_id, attributes, options \\ [])

Specs

create_domain(Dnsimple.Client.t, String.t | integer, map, Keyword.t) :: Dnsimple.Response.t

Creates a new domain in the account.

See https://developer.dnsimple.com/v2/domains/#create

delete_domain(client, account_id, domain_id, options \\ [])

Specs

delete_domain(Dnsimple.Client.t, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

PERMANENTLY deletes a domain from the account.

See https://developer.dnsimple.com/v2/domains/#delete

domain(client, account_id, domain_id, options \\ [])

Specs

Get a domain.

See https://developer.dnsimple.com/v2/domains/#get

domains(client, account_id, options \\ [])

Lists the domains.

See https://developer.dnsimple.com/v2/domains/#list

reset_domain_token(client, account_id, domain_id, options \\ [])

Specs

reset_domain_token(Dnsimple.Client.t, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Resets the domain token.

See https://developer.dnsimple.com/v2/domains/#reset-token