Package com.dnsimple.endpoints

Class Contacts

java.lang.Object

com.dnsimple.endpoints.Contacts

public class Contacts
extends java.lang.Object

Provides access to the DNSimple Contacts API.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
Contacts(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
SimpleResponse<Contact>	createContact(java.lang.Number account, ContactOptions options)	Create a contact in the account.
EmptyResponse	deleteContact(java.lang.Number account, java.lang.Number contactId)	Delete a contact from the account.
SimpleResponse<Contact>	getContact(java.lang.Number account, java.lang.Number contactId)	Get a specific contact associated to an account using the contacts's ID.
PaginatedResponse<Contact>	listContacts(java.lang.Number account)	Lists the contacts in the account.
PaginatedResponse<Contact>	listContacts(java.lang.Number account, ListOptions options)	Lists the contacts in the account.
SimpleResponse<Contact>	updateContact(java.lang.Number account, java.lang.Number contactId, ContactOptions options)	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

Contacts

public Contacts(HttpEndpointClient client)

Method Detail

listContacts

public PaginatedResponse<Contact> listContacts(java.lang.Number account)

Lists the contacts in the account.

Parameters:

account - The account ID

Returns:

The list contacts response

See Also:

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

listContacts

public PaginatedResponse<Contact> listContacts(java.lang.Number account,
                                               ListOptions options)

Lists the contacts in the account.

Parameters:

account - The account ID

options - The options for the list request

Returns:

The list contacts response

See Also:

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

createContact

public SimpleResponse<Contact> createContact(java.lang.Number account,
                                             ContactOptions options)

Create a contact in the account.

Parameters:

account - The account ID

options - options to create the new contact

Returns:

The create contact response

See Also:

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

getContact

public SimpleResponse<Contact> getContact(java.lang.Number account,
                                          java.lang.Number contactId)

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

Parameters:

account - The account ID

contactId - The contact ID

Returns:

The get contact response

See Also:

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

updateContact

public SimpleResponse<Contact> updateContact(java.lang.Number account,
                                             java.lang.Number contactId,
                                             ContactOptions options)

Update a contact in the account.

Parameters:

account - The account ID

contactId - The contact ID

options - options to update the contact

Returns:

The update contact response

See Also:

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

deleteContact

public EmptyResponse deleteContact(java.lang.Number account,
                                   java.lang.Number contactId)

Delete a contact from the account.

Parameters:

account - The account ID

contactId - The contact ID

Returns:

The delete contact response

See Also:

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