Package com.dnsimple.endpoints

Class Registrar

java.lang.Object

com.dnsimple.endpoints.Registrar

public class Registrar
extends Object

Provides access to the DNSimple Registrar API.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
Registrar(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
EmptyResponse	authorizeTransferOut(Number account, String domain)	Authorizes the transfer of a domain out of DNSimple.
SimpleResponse<DomainTransfer>	cancelDomainTransfer(Number account, String domain, Number domainTransferId)	Cancels an in progress domain transfer.
ListResponse<String>	changeDomainDelegation(Number account, String domain, List<String> nameServerNames)	Change name servers the domain is delegating to.
EmptyResponse	changeDomainDelegationFromVanity(Number account, String domain)	Change the domain delegation back to the standard DNSimple name servers.
ListResponse<VanityNameServer>	changeDomainDelegationToVanity(Number account, String domain, List<String> nameServerNames)	Change the domain delegation to the specified vanity name servers.
SimpleResponse<DomainCheck>	checkDomain(Number account, String domainName)	Checks whether a domain is available for registration.
SimpleResponse<RegistrantChangeCheck>	checkRegistrantChange(Number account, CheckRegistrantChangeInput input)	Retrieves the requirements of a registrant change.
SimpleResponse<RegistrantChange>	createRegistrantChange(Number account, CreateRegistrantChangeInput input)	Start a registrant change.
EmptyResponse	deleteRegistrantChange(Number account, Number registrantChange)	Cancel an ongoing registrant change from the account.
EmptyResponse	disableAutoRenewal(Number account, String domain)	Disable auto renewal for the domain in the account.
SimpleResponse<DomainTransferLock>	disableDomainTransferLock(Number account, String domain)	Unlocks the domain to allow domain transfers.
SimpleResponse<WhoisPrivacy>	disableWhoisPrivacy(Number account, String domain)	Disable whois privacy for the domain.
EmptyResponse	enableAutoRenewal(Number account, String domain)	Enable auto renewal for the domain in the account.
SimpleResponse<DomainTransferLock>	enableDomainTransferLock(Number account, String domain)	Locks the domain to prevent unauthorized transfers.
SimpleResponse<WhoisPrivacy>	enableWhoisPrivacy(Number account, String domain)	Enable whois privacy for the domain.
ListResponse<String>	getDomainDelegation(Number account, String domain)	Lists name servers the domain is delegating to.
SimpleResponse<DomainPremiumPriceCheck>	getDomainPremiumPrice(Number account, String domainName, DomainCheckPremiumPriceAction action)	Deprecated, for removal: This API element is subject to removal in a future version. use getDomainPrices(Number, String) instead
SimpleResponse<DomainPrice>	getDomainPrices(Number account, String domainName)	Get prices for registration, transfer, and renewal for a domain.
SimpleResponse<DomainRegistration>	getDomainRegistration(Number account, String domainName, Number domainRegistration)	Get the details of an existing domain registration.
SimpleResponse<DomainRenewal>	getDomainRenewal(Number account, String domainName, Number domainRenewal)	Get the details of an existing domain renewal.
SimpleResponse<DomainTransfer>	getDomainTransfer(Number account, String domain, Number domainTransferId)	Retrieves the details of an existing domain transfer.
SimpleResponse<DomainTransferLock>	getDomainTransferLock(Number account, String domain)	Gets the transfer lock status for a domain.
SimpleResponse<RegistrantChange>	getRegistrantChange(Number account, Number registrantChange)	Retrieves the details of an existing registrant change.
SimpleResponse<WhoisPrivacy>	getWhoisPrivacy(Number account, String domain)	Gets the whois privacy for the domain.
ListResponse<RegistrantChange>	listRegistrantChanges(Number account, ListOptions options)	List registrant changes in the account.
SimpleResponse<DomainRegistration>	registerDomain(Number account, String domainName, RegistrationOptions options)	Registers a domain.
SimpleResponse<DomainRenewal>	renewDomain(Number account, String domain, RenewOptions options)	Renews a domain.
SimpleResponse<WhoisPrivacyRenewal>	renewWhoisPrivacy(Number account, String domain)	Renew whois privacy for the domain.
SimpleResponse<DomainTransfer>	transferDomain(Number account, String domain, TransferOptions options)	Starts the transfer of a domain to DNSimple.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Registrar

public Registrar(HttpEndpointClient client)

Method Details

checkDomain

public SimpleResponse<DomainCheck> checkDomain(Number account,
 String domainName)

Checks whether a domain is available for registration.

Parameters:

account - The account ID

domainName - The domain to check

Returns:

The check domain response

See Also:

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

getDomainPremiumPrice

@Deprecated(since="0.9.1",
            forRemoval=true)
public SimpleResponse<DomainPremiumPriceCheck> getDomainPremiumPrice(Number account,
 String domainName,
 DomainCheckPremiumPriceAction action)

Deprecated, for removal: This API element is subject to removal in a future version.

use getDomainPrices(Number, String) instead

Checks the premium price of a domain for the provided action.

Parameters:

account - The account ID

domainName - The domain to check

action - The action to get the price of

Returns:

The premium price

See Also:

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

getDomainPrices

public SimpleResponse<DomainPrice> getDomainPrices(Number account,
 String domainName)

Get prices for registration, transfer, and renewal for a domain.

Parameters:

account - The account ID

domainName - The domain to check the prices

Returns:

the domain prices response

See Also:

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

getDomainRegistration

public SimpleResponse<DomainRegistration> getDomainRegistration(Number account,
 String domainName,
 Number domainRegistration)

Get the details of an existing domain registration.

Parameters:

account - The account ID

domainName - The domain to check the registration

domainRegistration - The domain registration ID

Returns:

the domain registration response

See Also:

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

getDomainRenewal

public SimpleResponse<DomainRenewal> getDomainRenewal(Number account,
 String domainName,
 Number domainRenewal)

Get the details of an existing domain renewal.

Parameters:

account - The account ID

domainName - The domain to check the renewal

domainRenewal - The domain renewal ID

Returns:

the domain renewal response

See Also:

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

registerDomain

public SimpleResponse<DomainRegistration> registerDomain(Number account,
 String domainName,
 RegistrationOptions options)

Registers a domain.

Parameters:

account - The account ID

domainName - The domain to register

options - The options for the domain registration

Returns:

The register domain response

See Also:

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

transferDomain

public SimpleResponse<DomainTransfer> transferDomain(Number account,
 String domain,
 TransferOptions options)

Starts the transfer of a domain to DNSimple.

Parameters:

account - The account ID

domain - The domain name or ID

options - The options for the transfer

Returns:

The transfer domain response

See Also:

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

getDomainTransfer

public SimpleResponse<DomainTransfer> getDomainTransfer(Number account,
 String domain,
 Number domainTransferId)

Retrieves the details of an existing domain transfer.

Parameters:

account - The account ID

domain - The domain name or ID

domainTransferId - The domain transfer ID

Returns:

The transfer domain response

See Also:

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

cancelDomainTransfer

public SimpleResponse<DomainTransfer> cancelDomainTransfer(Number account,
 String domain,
 Number domainTransferId)

Cancels an in progress domain transfer.

Parameters:

account - The account ID

domain - The domain name or ID

domainTransferId - The domain transfer ID

Returns:

The transfer domain response

See Also:

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

renewDomain

public SimpleResponse<DomainRenewal> renewDomain(Number account,
 String domain,
 RenewOptions options)

Renews a domain.

Parameters:

account - The account ID

domain - The domain name or ID

options - The options for the renewal

Returns:

The renew domain response

See Also:

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

authorizeTransferOut

public EmptyResponse authorizeTransferOut(Number account,
 String domain)

Authorizes the transfer of a domain out of DNSimple.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The transfer domain out response

See Also:

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

enableAutoRenewal

public EmptyResponse enableAutoRenewal(Number account,
 String domain)

Enable auto renewal for the domain in the account.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The enable auto renewal response

See Also:

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

disableAutoRenewal

public EmptyResponse disableAutoRenewal(Number account,
 String domain)

Disable auto renewal for the domain in the account.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The disable auto renewal response

See Also:

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

getWhoisPrivacy

public SimpleResponse<WhoisPrivacy> getWhoisPrivacy(Number account,
 String domain)

Gets the whois privacy for the domain.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The get whois privacy response

See Also:

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

enableWhoisPrivacy

public SimpleResponse<WhoisPrivacy> enableWhoisPrivacy(Number account,
 String domain)

Enable whois privacy for the domain.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The enable whois privacy response

See Also:

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

disableWhoisPrivacy

public SimpleResponse<WhoisPrivacy> disableWhoisPrivacy(Number account,
 String domain)

Disable whois privacy for the domain.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The disable whois privacy response

See Also:

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

renewWhoisPrivacy

public SimpleResponse<WhoisPrivacyRenewal> renewWhoisPrivacy(Number account,
 String domain)

Renew whois privacy for the domain.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The disable whois privacy response

See Also:

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

getDomainDelegation

public ListResponse<String> getDomainDelegation(Number account,
 String domain)

Lists name servers the domain is delegating to.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The get domain delegation response

See Also:

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

changeDomainDelegation

public ListResponse<String> changeDomainDelegation(Number account,
 String domain,
 List<String> nameServerNames)

Change name servers the domain is delegating to.

Parameters:

account - The account ID

domain - The domain ID or name

nameServerNames - The name server names to change the delegation to

Returns:

The change domain delegation response

See Also:

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

changeDomainDelegationToVanity

public ListResponse<VanityNameServer> changeDomainDelegationToVanity(Number account,
 String domain,
 List<String> nameServerNames)

Change the domain delegation to the specified vanity name servers.

Parameters:

account - The account ID

domain - The domain ID or name

nameServerNames - The vanity name server names

Returns:

The change domain delegation to vanity response

See Also:

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

changeDomainDelegationFromVanity

public EmptyResponse changeDomainDelegationFromVanity(Number account,
 String domain)

Change the domain delegation back to the standard DNSimple name servers.

Parameters:

account - The account ID

domain - The domain ID or name

Returns:

The change domain delegation from vanity response

See Also:

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

listRegistrantChanges

public ListResponse<RegistrantChange> listRegistrantChanges(Number account,
 ListOptions options)

List registrant changes in the account.

Parameters:

account - The account ID

options - List options

Returns:

Registrant changes

See Also:

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

createRegistrantChange

public SimpleResponse<RegistrantChange> createRegistrantChange(Number account,
 CreateRegistrantChangeInput input)

Start a registrant change.

Parameters:

account - The account ID

input - The input parameters

Returns:

The registrant change response

See Also:

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

checkRegistrantChange

public SimpleResponse<RegistrantChangeCheck> checkRegistrantChange(Number account,
 CheckRegistrantChangeInput input)

Retrieves the requirements of a registrant change.

Parameters:

account - The account ID

input - The domain and contact to check

Returns:

The registrant change check response

See Also:

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

getRegistrantChange

public SimpleResponse<RegistrantChange> getRegistrantChange(Number account,
 Number registrantChange)

Retrieves the details of an existing registrant change.

Parameters:

account - The account ID

registrantChange - The registrant change

Returns:

The registrant change response

See Also:

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

deleteRegistrantChange

public EmptyResponse deleteRegistrantChange(Number account,
 Number registrantChange)

Cancel an ongoing registrant change from the account.

Parameters:

account - The account ID

registrantChange - The registrant change

Returns:

The registrant change response

See Also:

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

getDomainTransferLock

public SimpleResponse<DomainTransferLock> getDomainTransferLock(Number account,
 String domain)

Gets the transfer lock status for a domain.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The transfer lock status

See Also:

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

enableDomainTransferLock

public SimpleResponse<DomainTransferLock> enableDomainTransferLock(Number account,
 String domain)

Locks the domain to prevent unauthorized transfers.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The transfer lock status

See Also:

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

disableDomainTransferLock

public SimpleResponse<DomainTransferLock> disableDomainTransferLock(Number account,
 String domain)

Unlocks the domain to allow domain transfers.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The transfer lock status

See Also:

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