@spec 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:

• https://developer.dnsimple.com/v2/registrar/#cancelDomainTransfer

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)

@spec 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:

• https://developer.dnsimple.com/v2/registrar/delegation/#changeDomainDelegation

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",
])

@spec 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:

• https://developer.dnsimple.com/v2/registrar/delegation/#changeDomainDelegationFromVanity

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.change_domain_delegation_from_vanity(client, account_id = 1010, domain_id = "example.com")

@spec 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:

• https://developer.dnsimple.com/v2/registrar/delegation/#changeDomainDelegationToVanity

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",
])

@spec 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:

• https://developer.dnsimple.com/v2/registrar/#check

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.check_domain(client, account_id = 1010, domain_id = "example.com")

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

Retrieves the requirements of a registrant change

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"} {:ok, response} = Dnsimple.Registrar.check_registrant_change(client, account_id = 1010, %{

contact_id: 1,
domain_id: "example.com",

})

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

Start registrant change.

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"} {:ok, response} = Dnsimple.Registrar.create_registrant_change(client, account_id = 1010, %{

contact_id: 1,
domain_id: "example.com",
extended_attributes: %{
  "x-fake-attribute" => "value",
}

})

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

Cancel an ongoing registrant change from the account.

Examples

client = %Dnsimple.Client{access_token: "a1b2c3d4"} {:ok, response} = Dnsimple.Registrar.delete_registrant_change(client, account_id = 1010, registrant_change_id = 1)

@spec 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:

• https://developer.dnsimple.com/v2/registrar/auto-renewal/#disableDomainAutoRenewal

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.disable_domain_auto_renewal(client, account_id = 1010, domain_id = "example.com")

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

Disables transfer lock for the domain.

See:

• https://developer.dnsimple.com/v2/registrar/transfer_lock/#disableDomainTransferLock

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.disable_domain_transfer_lock(client, account_id = 1010, domain_id = "example.com")

@spec 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:

• https://developer.dnsimple.com/v2/registrar/whois-privacy/#disableWhoisPrivacy

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.disable_whois_privacy(client, account_id = 1010, domain_id = "example.com")

@spec 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:

• https://developer.dnsimple.com/v2/registrar/auto-renewal/#enableDomainAutoRenewal

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.enable_domain_auto_renewal(client, account_id = 1010, domain_id = "example.com")

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

Enables transfer lock for the domain.

See:

• https://developer.dnsimple.com/v2/registrar/transfer_lock/#enableDomainTransferLock

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.enable_domain_transfer_lock(client, account_id = 1010, domain_id = "example.com")

@spec 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:

• https://developer.dnsimple.com/v2/registrar/whois-privacy/#enableWhoisPrivacy

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.enable_whois_privacy(client, account_id = 1010, domain_id = "example.com")

@spec 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:

• https://developer.dnsimple.com/v2/registrar/delegation/#getDomainDelegation

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_delegation(client, account_id = 1010, domain_id = "example.com")

@spec get_domain_premium_price(
  Dnsimple.Client.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok | :error, Dnsimple.Response.t()}

Gets the premium price for a domain.

See:

• https://developer.dnsimple.com/v2/registrar/#getDomainPremiumPrice

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_premium_price(client, account_id = "1010", domain_id = "example.com")
{:ok, response} = Dnsimple.Registrar.get_domain_premium_price(client, account_id = "1010", domain_id = "example.com", %{action: "registration"})
{:ok, response} = Dnsimple.Registrar.get_domain_premium_price(client, account_id = "1010", domain_id = "example.com", %{action: "renewal"})
{:ok, response} = Dnsimple.Registrar.get_domain_premium_price(client, account_id = "1010", domain_id = "example.com", %{action: "transfer"})

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

Get prices for a domain.

See:

• https://developer.dnsimple.com/v2/registrar/#getDomainPrices

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_prices(client, account_id = "1010", domain_id = "example.com")

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

Retrieve the details of an existing domain registration.

See:

• https://developer.dnsimple.com/v2/registrar/#getDomainRegistration

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_registration(client, account_id = 1010, domain_id = "example.com", registration_id = 1)

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

Retrieve the details of an existing domain renewal.

See:

• https://developer.dnsimple.com/v2/registrar/#getDomainRenewal

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_renewal(client, account_id = 1010, domain_id = "example.com", renewal_id = 1)

@spec 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:

• https://developer.dnsimple.com/v2/registrar/#getDomainTransfer

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)

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

Retrieves the transfer lock status for the domain.

See:

• https://developer.dnsimple.com/v2/registrar/transfer_lock/#getDomainTransferLock

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_domain_transfer_lock(client, account_id = 1010, domain_id = "example.com")

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

Retrieves the details of an existing registrant change.

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"} {:ok, response} = Dnsimple.Registrar.get_registrant_change(client, account_id = 1010, registrant_change_id = 1)

@spec 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:

• https://developer.dnsimple.com/v2/registrar/whois-privacy/#getWhoisPrivacy

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.get_whois_privacy(client, account_id = 1010, domain_id = "example.com")

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

List registrant changes in the account.

Examples

client = %Dnsimple.Client{access_token: "a1b2c3d4"} {:ok, response} = Dnsimple.Registrar.list_registrant_changes(client, account_id = 1010)

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

Registers a domain.

See:

• https://developer.dnsimple.com/v2/registrar/#registerDomain

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,
})

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

Renews a domain.

See:

• https://developer.dnsimple.com/v2/registrar/#renewDomain

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})

@spec 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:

• https://developer.dnsimple.com/v2/registrar/whois-privacy/#renewWhoisPrivacy

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.renew_whois_privacy(client, account_id = 1010, domain_id = "example.com")

@spec 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:

• https://developer.dnsimple.com/v2/registrar/#transferDomain

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,
})

@spec 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:

• https://developer.dnsimple.com/v2/registrar/#authorizeDomainTransferOut

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Registrar.transfer_domain_out(client, account_id = 1010, domain_id = "example.com")