com.dnsimple

Interface Contacts

All Known Implementing Classes:

ContactsEndpoint

public interface Contacts

Provides access to the DNSimple Contacts API.

See Also:

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

Method Summary

Modifier and Type	Method and Description
CreateContactResponse	createContact(String accountId, Map<String,Object> attributes) Create a contact in the account.
DeleteContactResponse	deleteContact(String accountId, String contactId) Delete a contact from the account.
GetContactResponse	getContact(String accountId, String contactId) Get a specific contact associated to an account using the contacts's ID.
ListContactsResponse	listContacts(String accountId) Lists the contacts in the account.
ListContactsResponse	listContacts(String accountId, Map<String,Object> options) Lists the contacts in the account.
UpdateContactResponse	updateContact(String accountId, String contactId, Map<String,Object> attributes) Update a contact in the account.

Method Detail

listContacts

ListContactsResponse listContacts(String accountId)
                           throws DnsimpleException,
                                  IOException

Lists the contacts in the account.

Parameters:

accountId - The account ID

Returns:

The list contacts response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/contacts/#list

listContacts

ListContactsResponse listContacts(String accountId,
                                  Map<String,Object> options)
                           throws DnsimpleException,
                                  IOException

Lists the contacts in the account.

Parameters:

accountId - The account ID

options - A Map of options to pass to the contacts API

Returns:

The list contacts response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/contacts/#list

getContact

GetContactResponse getContact(String accountId,
                              String contactId)
                       throws DnsimpleException,
                              IOException

Get a specific contact associated to an account using the contacts's ID.

Parameters:

accountId - The account ID

contactId - The contact ID

Returns:

The get contact response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/contacts/#get

createContact

CreateContactResponse createContact(String accountId,
                                    Map<String,Object> attributes)
                             throws DnsimpleException,
                                    IOException

Create a contact in the account.

Parameters:

accountId - The account ID

attributes - A map of attributes to contruct the contact

Returns:

The create contact response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/contacts/#create

updateContact

UpdateContactResponse updateContact(String accountId,
                                    String contactId,
                                    Map<String,Object> attributes)
                             throws DnsimpleException,
                                    IOException

Update a contact in the account.

Parameters:

accountId - The account ID

contactId - The contact ID

attributes - A map of attributes to update the contact

Returns:

The update contact response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/contacts/#update

deleteContact

DeleteContactResponse deleteContact(String accountId,
                                    String contactId)
                             throws DnsimpleException,
                                    IOException

Delete a contact from the account.

Parameters:

accountId - The account ID

contactId - The contact ID

Returns:

The delete contact response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/contacts/#delete