dnsimple v1.1.1 Dnsimple.Registrar
Provides functions to interact with the registrar endpoints.
See:
Summary
Functions
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
Returns the whois privacy of the domain
Registers a domain
Starts the transfer of a domain to DNSimple
Requests the transfer of a domain out of DNSimple
Functions
Specs
change_domain_delegation(Dnsimple.Client.t, integer | String.t, String.t, List.t, Keyword.t) :: Dnsimple.Response.tChanges 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",
])Specs
change_domain_delegation_from_vanity(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tReverts 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")Specs
change_domain_delegation_to_vanity(Dnsimple.Client.t, integer | String.t, String.t, List.t, Keyword.t) :: Dnsimple.Response.tDelegates 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.t) :: Dnsimple.Response.tChecks 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")Specs
disable_domain_auto_renewal(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tDisables 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")Specs
disable_whois_privacy(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tDisables 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")Specs
enable_domain_auto_renewal(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tEnables 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")Specs
enable_whois_privacy(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tEnables 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")Specs
get_domain_delegation(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tReturns 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_whois_privacy(Dnsimple.Client.t, integer | String.t, String.t, Keyword.t) :: Dnsimple.Response.tReturns 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")Specs
register_domain(Dnsimple.Client.t, String.t, String.t, Keyword.t, Keyword.t) :: Dnsimple.Response.tRegisters 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,
})Specs
renew_domain(Dnsimple.Client.t, String.t, String.t, Keyword.t, Keyword.t) :: Dnsimple.Response.tRenews 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})Specs
transfer_domain(Dnsimple.Client.t, String.t, String.t, Keyword.t, Keyword.t) :: Dnsimple.Response.tStarts 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,
})Specs
transfer_domain_out(Dnsimple.Client.t, String.t, String.t, Keyword.t) :: Dnsimple.Response.tRequests 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")