Dnsimple.Registrar (dnsimple v3.1.1) View Source
Provides functions to interact with the registrar endpoints.
See:
Link to this section Summary
Functions
Cancels an in progress domain transfer.
Changes the domain's name servers and returns them.
Reverts all the operations performed to delegate to vanity name servers and delegates the domain back to DNSimple's name servers (if DNSimple is the registrar of the domain).
Delegates the domain to vanity name servers.
Checks if a domain name is available to be registered and whether premium pricing applies to that domain name.
Disables auto-renewal for the domain.
Disables whois privacy for the domain.
Enables auto-renewal for the domain.
Enables whois privacy for the domain.
Returns the name servers the domain is delegating to.
Gets the premium price for a domain.
Get prices for a domain.
Retrieves the details of an existing domain transfer.
Returns the whois privacy of the domain.
Registers a domain.
Renews whois privacy for the domain.
Starts the transfer of a domain to DNSimple.
Requests the transfer of a domain out of DNSimple.
Link to this section Functions
cancel_domain_transfer(client, account_id, domain_name, domain_transfer_id, options \\ [])
View SourceSpecs
cancel_domain_transfer( Dnsimple.Client.t(), String.t() | integer(), String.t(), String.t() | integer(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Cancels an in progress domain transfer.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.cancel_domain_transfer(client, account_id = 1010, domain_name = "example.com", transfer_id = 42)
change_domain_delegation(client, account_id, domain_name, name_servers, options \\ [])
View SourceSpecs
change_domain_delegation( Dnsimple.Client.t(), integer() | String.t(), String.t(), list(), keyword() ) :: {:ok | :error, Dnsimple.Response.t()}
Changes the domain's name servers and returns them.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.change_domain_delegation(client, account_id = 1010, domain_id = "example.com", [
"ns1.provider.com",
"ns2.provider.com",
"ns3.provider.com",
"ns4.provider.com",
])
change_domain_delegation_from_vanity(client, account_id, domain_name, options \\ [])
View SourceSpecs
change_domain_delegation_from_vanity( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Reverts all the operations performed to delegate to vanity name servers and delegates the domain back to DNSimple's name servers (if DNSimple is the registrar of the domain).
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.change_domain_delegation_from_vanity(client, account_id = 1010, domain_id = "example.com")
change_domain_delegation_to_vanity(client, account_id, domain_name, name_servers, options \\ [])
View SourceSpecs
change_domain_delegation_to_vanity( Dnsimple.Client.t(), integer() | String.t(), String.t(), list(), keyword() ) :: {:ok | :error, Dnsimple.Response.t()}
Delegates the domain to vanity name servers.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.change_domain_delegation_to_vanity(client, account_id = 1010, domain_id = "example.com", [
"ns1.example.com",
"ns2.example.com",
"ns3.example.com",
"ns4.example.com",
])
Specs
check_domain(Dnsimple.Client.t(), String.t(), String.t(), keyword()) :: {:ok | :error, Dnsimple.Response.t()}
Checks if a domain name is available to be registered and whether premium pricing applies to that domain name.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.check_domain(client, account_id = 1010, domain_id = "example.com")
disable_domain_auto_renewal(client, account_id, domain_name, options \\ [])
View SourceSpecs
disable_domain_auto_renewal( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Disables auto-renewal for the domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.disable_domain_auto_renewal(client, account_id = 1010, domain_id = "example.com")
disable_whois_privacy(client, account_id, domain_name, options \\ [])
View SourceSpecs
disable_whois_privacy( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Disables whois privacy for the domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.disable_whois_privacy(client, account_id = 1010, domain_id = "example.com")
enable_domain_auto_renewal(client, account_id, domain_name, options \\ [])
View SourceSpecs
enable_domain_auto_renewal( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Enables auto-renewal for the domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.enable_domain_auto_renewal(client, account_id = 1010, domain_id = "example.com")
enable_whois_privacy(client, account_id, domain_name, options \\ [])
View SourceSpecs
enable_whois_privacy( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Enables whois privacy for the domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.enable_whois_privacy(client, account_id = 1010, domain_id = "example.com")
get_domain_delegation(client, account_id, domain_name, options \\ [])
View SourceSpecs
get_domain_delegation( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Returns the name servers the domain is delegating to.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_delegation(client, account_id = 1010, domain_id = "example.com")
Specs
get_domain_prices(Dnsimple.Client.t(), String.t(), String.t(), keyword()) :: {:ok | :error, Dnsimple.Response.t()}
Get prices for a domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_prices(client, account_id = "1010", domain_id = "example.com")
get_domain_transfer(client, account_id, domain_name, domain_transfer_id, options \\ [])
View SourceSpecs
get_domain_transfer( Dnsimple.Client.t(), String.t() | integer(), String.t(), String.t() | integer(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Retrieves the details of an existing domain transfer.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_transfer(client, account_id = 1010, domain_name = "example.com", transfer_id = 42)
Specs
get_whois_privacy( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Returns the whois privacy of the domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_whois_privacy(client, account_id = 1010, domain_id = "example.com")
register_domain(client, account_id, domain_name, attributes \\ [], options \\ [])
View SourceSpecs
register_domain( Dnsimple.Client.t(), String.t(), String.t(), Keyword.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Registers a domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.register_domain(client, account_id = 1010, domain_id = "example.com", %{
registrant_id: 1,
privacy: true,
auto_renew: false,
})
renew_domain(client, account_id, domain_name, attributes \\ [], options \\ [])
View SourceSpecs
renew_domain( Dnsimple.Client.t(), String.t(), String.t(), Keyword.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Renews a domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.renew_domain(client, account_id = 1010, domain_id = "example.com")
{:ok, response} = Dnsimple.Registrar.renew_domain(client, account_id = 1010, domain_id = "example.com", %{period: 5})
renew_whois_privacy(client, account_id, domain_name, options \\ [])
View SourceSpecs
renew_whois_privacy( Dnsimple.Client.t(), integer() | String.t(), String.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Renews whois privacy for the domain.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.renew_whois_privacy(client, account_id = 1010, domain_id = "example.com")
transfer_domain(client, account_id, domain_name, attributes \\ [], options \\ [])
View SourceSpecs
transfer_domain( Dnsimple.Client.t(), String.t(), String.t(), Keyword.t(), Keyword.t() ) :: {:ok | :error, Dnsimple.Response.t()}
Starts the transfer of a domain to DNSimple.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.transfer_domain(client, account_id = 1010, domain_id = "example.com", %{
registrant_id: 1,
auth_code: "XXXXXXXXX",
privacy: true,
auto_renew: true,
})
transfer_domain_out(client, account_id, domain_name, options \\ [])
View SourceSpecs
transfer_domain_out(Dnsimple.Client.t(), String.t(), String.t(), Keyword.t()) :: {:ok | :error, Dnsimple.Response.t()}
Requests the transfer of a domain out of DNSimple.
See:
Examples:
client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.transfer_domain_out(client, account_id = 1010, domain_id = "example.com")