Package com.dnsimple.endpoints

Class Registrar

java.lang.Object

com.dnsimple.endpoints.Registrar

public class Registrar
extends java.lang.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(java.lang.Number account, java.lang.String domain)	Authorizes the transfer of a domain out of DNSimple.
SimpleResponse<DomainTransfer>	cancelDomainTransfer(java.lang.Number account, java.lang.String domain, java.lang.Number domainTransferId)	Cancels an in progress domain transfer.
ListResponse<java.lang.String>	changeDomainDelegation(java.lang.Number account, java.lang.String domain, java.util.List<java.lang.String> nameServerNames)	Change name servers the domain is delegating to.
EmptyResponse	changeDomainDelegationFromVanity(java.lang.Number account, java.lang.String domain)	Change the domain delegation back to the standard DNSimple name servers.
ListResponse<VanityNameServer>	changeDomainDelegationToVanity(java.lang.Number account, java.lang.String domain, java.util.List<java.lang.String> nameServerNames)	Change the domain delegation to the specified vanity name servers.
SimpleResponse<DomainCheck>	checkDomain(java.lang.Number account, java.lang.String domainName)	Checks whether a domain is available for registration.
EmptyResponse	disableAutoRenewal(java.lang.Number account, java.lang.String domain)	Disable auto renewal for the domain in the account.
SimpleResponse<WhoisPrivacy>	disableWhoisPrivacy(java.lang.Number account, java.lang.String domain)	Disable whois privacy for the domain.
EmptyResponse	enableAutoRenewal(java.lang.Number account, java.lang.String domain)	Enable auto renewal for the domain in the account.
SimpleResponse<WhoisPrivacy>	enableWhoisPrivacy(java.lang.Number account, java.lang.String domain)	Enable whois privacy for the domain.
ListResponse<java.lang.String>	getDomainDelegation(java.lang.Number account, java.lang.String domain)	Lists name servers the domain is delegating to.
SimpleResponse<DomainPremiumPriceCheck>	getDomainPremiumPrice(java.lang.Number account, java.lang.String domainName, DomainCheckPremiumPriceAction action)	Deprecated. As of this version 0.9.1, replaced by getDomainPrices(Number, String)
SimpleResponse<DomainPrice>	getDomainPrices(java.lang.Number account, java.lang.String domainName)	Get prices for registration, transfer, and renewal for a domain.
SimpleResponse<DomainTransfer>	getDomainTransfer(java.lang.Number account, java.lang.String domain, java.lang.Number domainTransferId)	Retrieves the details of an existing domain transfer.
SimpleResponse<WhoisPrivacy>	getWhoisPrivacy(java.lang.Number account, java.lang.String domain)	Gets the whois privacy for the domain.
SimpleResponse<DomainRegistration>	registerDomain(java.lang.Number account, java.lang.String domainName, RegistrationOptions options)	Registers a domain.
SimpleResponse<DomainRenewal>	renewDomain(java.lang.Number account, java.lang.String domain, RenewOptions options)	Renews a domain.
SimpleResponse<WhoisPrivacyRenewal>	renewWhoisPrivacy(java.lang.Number account, java.lang.String domain)	Renew whois privacy for the domain.
SimpleResponse<DomainTransfer>	transferDomain(java.lang.Number account, java.lang.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 Detail

Registrar

public Registrar(HttpEndpointClient client)

Method Detail

checkDomain

public SimpleResponse<DomainCheck> checkDomain(java.lang.Number account,
                                               java.lang.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
public SimpleResponse<DomainPremiumPriceCheck> getDomainPremiumPrice(java.lang.Number account,
                                                                     java.lang.String domainName,
                                                                     DomainCheckPremiumPriceAction action)

Deprecated.

As of this version 0.9.1, replaced by getDomainPrices(Number, String)

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(java.lang.Number account,
                                                   java.lang.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

registerDomain

public SimpleResponse<DomainRegistration> registerDomain(java.lang.Number account,
                                                         java.lang.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(java.lang.Number account,
                                                     java.lang.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(java.lang.Number account,
                                                        java.lang.String domain,
                                                        java.lang.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(java.lang.Number account,
                                                           java.lang.String domain,
                                                           java.lang.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(java.lang.Number account,
                                                 java.lang.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(java.lang.Number account,
                                          java.lang.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(java.lang.Number account,
                                       java.lang.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(java.lang.Number account,
                                        java.lang.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(java.lang.Number account,
                                                    java.lang.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(java.lang.Number account,
                                                       java.lang.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(java.lang.Number account,
                                                        java.lang.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(java.lang.Number account,
                                                             java.lang.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<java.lang.String> getDomainDelegation(java.lang.Number account,
                                                          java.lang.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<java.lang.String> changeDomainDelegation(java.lang.Number account,
                                                             java.lang.String domain,
                                                             java.util.List<java.lang.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(java.lang.Number account,
                                                                     java.lang.String domain,
                                                                     java.util.List<java.lang.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(java.lang.Number account,
                                                      java.lang.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