com.dnsimple.endpoints.http

Class ContactsEndpoint

java.lang.Object

com.dnsimple.endpoints.http.ContactsEndpoint

All Implemented Interfaces:

Contacts

public class ContactsEndpoint
extends Object
implements Contacts

Constructor Summary

Constructors

Constructor and Description
ContactsEndpoint(HttpEndpointClient client)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactsEndpoint

public ContactsEndpoint(HttpEndpointClient client)

Method Detail

listContacts

public ListContactsResponse listContacts(String accountId)
                                  throws DnsimpleException,
                                         IOException

Description copied from interface: Contacts

Lists the contacts in the account.

Specified by:

listContacts in interface Contacts

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

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

Description copied from interface: Contacts

Lists the contacts in the account.

Specified by:

listContacts in interface Contacts

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

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

Description copied from interface: Contacts

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

Specified by:

getContact in interface Contacts

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

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

Description copied from interface: Contacts

Create a contact in the account.

Specified by:

createContact in interface Contacts

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

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

Description copied from interface: Contacts

Update a contact in the account.

Specified by:

updateContact in interface Contacts

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

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

Description copied from interface: Contacts

Delete a contact from the account.

Specified by:

deleteContact in interface Contacts

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