Registrar (dnsimple-java 0.2.0 API)

All Known Implementing Classes:

RegistrarEndpoint
```
public interface Registrar
```
Provides access to the DNSimple Registrar API.

See Also:

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangeDomainDelegationResponse`	`changeDomainDelegation(String accountId, String domainId, List<String> nameServerNames)` Change name servers the domain is delegating to.
`ChangeDomainDelegationFromVanityResponse`	`changeDomainDelegationFromVanity(String accountId, String domainId)` Change the domain delegation back to the standard DNSimple name servers.
`ChangeDomainDelegationToVanityResponse`	`changeDomainDelegationToVanity(String accountId, String domainId, List<String> nameServerNames)` Change the domain delegation to the specified vanity name servers.
`CheckDomainResponse`	`checkDomain(String accountId, String domainName)` Checks whether a domain is available for registration.
`DisableAutoRenewalResponse`	`disableAutoRenewal(String accountId, String domainId)` Disable auto renewal for the domain in the account.
`DisableWhoisPrivacyResponse`	`disableWhoisPrivacy(String accountId, String domainId)` Disable whois privacy for the domain.
`EnableAutoRenewalResponse`	`enableAutoRenewal(String accountId, String domainId)` Enable auto renewal for the domain in the account.
`EnableWhoisPrivacyResponse`	`enableWhoisPrivacy(String accountId, String domainId)` Enable whois privacy for the domain.
`GetDomainDelegationResponse`	`getDomainDelegation(String accountId, String domainId)` Lists name servers the domain is delegating to.
`GetWhoisPrivacyResponse`	`getWhoisPrivacy(String accountId, String domainId)` Gets the whois privacy for the domain.
`RegisterDomainResponse`	`registerDomain(String accountId, String domainName, Map<String,Object> attributes)` Registers a domain.
`RenewDomainResponse`	`renewDomain(String accountId, String domainId, Map<String,Object> attributes)` Renews a domain.
`TransferDomainResponse`	`transferDomain(String accountId, String domainId, Map<String,Object> attributes)` Starts the transfer of a domain to DNSimple.
`TransferDomainOutResponse`	`transferDomainOut(String accountId, String domainId)` Requests the transfer of a domain out of DNSimple.

Method Detail

checkDomain
```
CheckDomainResponse checkDomain(String accountId,
                                String domainName)
                         throws DnsimpleException,
                                IOException
```
Checks whether a domain is available for registration.

Parameters:

accountId - The account ID

domainName - The domain to check

Returns:

The check domain response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

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

registerDomain

RegisterDomainResponse registerDomain(String accountId,
                                      String domainName,
                                      Map<String,Object> attributes)
                               throws DnsimpleException,
                                      IOException

Registers a domain.

Parameters:: accountId - The account ID; domainName - The domain to register; attributes - Attributes to use for the registration
Returns:: The register domain response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/#register

renewDomain

RenewDomainResponse renewDomain(String accountId,
                                String domainId,
                                Map<String,Object> attributes)
                         throws DnsimpleException,
                                IOException

Renews a domain.

Parameters:: accountId - The account ID; domainId - The domain name or ID; attributes - Attributes to use for the renewal
Returns:: The renew domain response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/#renew

transferDomain

TransferDomainResponse transferDomain(String accountId,
                                      String domainId,
                                      Map<String,Object> attributes)
                               throws DnsimpleException,
                                      IOException

Starts the transfer of a domain to DNSimple.

Parameters:: accountId - The account ID; domainId - The domain name or ID; attributes - Attributes to use for the transfer
Returns:: The transfer domain response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/#transfer

transferDomainOut

TransferDomainOutResponse transferDomainOut(String accountId,
                                            String domainId)
                                     throws DnsimpleException,
                                            IOException

Requests the transfer of a domain out of DNSimple.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The transfer domain out response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/#transfer-out

enableAutoRenewal

EnableAutoRenewalResponse enableAutoRenewal(String accountId,
                                            String domainId)
                                     throws DnsimpleException,
                                            IOException

Enable auto renewal for the domain in the account.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The enable auto renewal response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/auto-renewal/#enable

disableAutoRenewal

DisableAutoRenewalResponse disableAutoRenewal(String accountId,
                                              String domainId)
                                       throws DnsimpleException,
                                              IOException

Disable auto renewal for the domain in the account.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The disable auto renewal response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/auto-renewal/#disable

getWhoisPrivacy

GetWhoisPrivacyResponse getWhoisPrivacy(String accountId,
                                        String domainId)
                                 throws DnsimpleException,
                                        IOException

Gets the whois privacy for the domain.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The get whois privacy response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/whois-privacy/#get

enableWhoisPrivacy

EnableWhoisPrivacyResponse enableWhoisPrivacy(String accountId,
                                              String domainId)
                                       throws DnsimpleException,
                                              IOException

Enable whois privacy for the domain.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The enable whois privacy response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/whois-privacy/#enable

disableWhoisPrivacy

DisableWhoisPrivacyResponse disableWhoisPrivacy(String accountId,
                                                String domainId)
                                         throws DnsimpleException,
                                                IOException

Disable whois privacy for the domain.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The disable whois privacy response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/whois-privacy/#disable

getDomainDelegation

GetDomainDelegationResponse getDomainDelegation(String accountId,
                                                String domainId)
                                         throws DnsimpleException,
                                                IOException

Lists name servers the domain is delegating to.

Parameters:: accountId - The account ID; domainId - The domain name or ID
Returns:: The get domain delegation response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/delegation/#list

changeDomainDelegation

ChangeDomainDelegationResponse changeDomainDelegation(String accountId,
                                                      String domainId,
                                                      List<String> nameServerNames)
                                               throws DnsimpleException,
                                                      IOException

Change name servers the domain is delegating to.

Parameters:: accountId - The account ID; domainId - The domain ID; nameServerNames - The name server names to change the delegation to
Returns:: The change domain delegation response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/delegation/#update

changeDomainDelegationToVanity

ChangeDomainDelegationToVanityResponse changeDomainDelegationToVanity(String accountId,
                                                                      String domainId,
                                                                      List<String> nameServerNames)
                                                               throws DnsimpleException,
                                                                      IOException

Change the domain delegation to the specified vanity name servers.

Parameters:: accountId - The account ID; domainId - The domain ID; nameServerNames - The vanity name server names
Returns:: The change domain delegation to vanity response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/delegation/#delegateToVanity

changeDomainDelegationFromVanity

ChangeDomainDelegationFromVanityResponse changeDomainDelegationFromVanity(String accountId,
                                                                          String domainId)
                                                                   throws DnsimpleException,
                                                                          IOException

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

Parameters:: accountId - The account ID; domainId - The domain ID
Returns:: The change domain delegation from vanity response
Throws:: DnsimpleException - Any API error; IOException - Any IO error
See Also:: https://developer.dnsimple.com/v2/registrar/delegation/#delegateFromVanity

Interface Registrar