com.dnsimple.endpoints.http

Class TemplatesEndpoint

java.lang.Object

com.dnsimple.endpoints.http.TemplatesEndpoint

All Implemented Interfaces:

Templates

public class TemplatesEndpoint
extends Object
implements Templates

Constructor Summary

Constructors

Constructor and Description
TemplatesEndpoint(HttpEndpointClient client)

Method Summary

Modifier and Type	Method and Description
ApplyTemplateResponse	applyTemplate(String accountId, String templateId, String domainId) Apply a template from the account to the domain
CreateTemplateResponse	createTemplate(String accountId, Map<String,Object> attributes) Create a template in the account.
CreateTemplateRecordResponse	createTemplateRecord(String accountId, String templateId, Map<String,Object> attributes) Create a record in the template.
DeleteTemplateResponse	deleteTemplate(String accountId, String templateId) Delete a template from the account.
DeleteTemplateRecordResponse	deleteTemplateRecord(String accountId, String templateId, String recordId) Delete a record from the template.
GetTemplateResponse	getTemplate(String accountId, String templateId) Get a specific template associated to an account using the templates's ID.
GetTemplateRecordResponse	getTemplateRecord(String accountId, String templateId, String recordId) Get a specific record associated to a template using the record's ID.
ListTemplateRecordsResponse	listTemplateRecords(String accountId, String templateId) Lists the records in the template.
ListTemplateRecordsResponse	listTemplateRecords(String accountId, String templateId, Map<String,Object> options) Lists the records in the template.
ListTemplatesResponse	listTemplates(String accountId) Lists the templates in the account.
ListTemplatesResponse	listTemplates(String accountId, Map<String,Object> options) Lists the templates in the account.
UpdateTemplateResponse	updateTemplate(String accountId, String templateId, Map<String,Object> attributes) Update a template in the account.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplatesEndpoint

public TemplatesEndpoint(HttpEndpointClient client)

Method Detail

listTemplates

public ListTemplatesResponse listTemplates(String accountId)
                                    throws DnsimpleException,
                                           IOException

Description copied from interface: Templates

Lists the templates in the account.

Specified by:

listTemplates in interface Templates

Parameters:

accountId - The account ID

Returns:

The list templates response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

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

listTemplates

public ListTemplatesResponse listTemplates(String accountId,
                                           Map<String,Object> options)
                                    throws DnsimpleException,
                                           IOException

Description copied from interface: Templates

Lists the templates in the account.

Specified by:

listTemplates in interface Templates

Parameters:

accountId - The account ID

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

Returns:

The list templates response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

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

getTemplate

public GetTemplateResponse getTemplate(String accountId,
                                       String templateId)
                                throws DnsimpleException,
                                       IOException

Description copied from interface: Templates

Get a specific template associated to an account using the templates's ID.

Specified by:

getTemplate in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

Returns:

The get template response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

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

createTemplate

public CreateTemplateResponse createTemplate(String accountId,
                                             Map<String,Object> attributes)
                                      throws DnsimpleException,
                                             IOException

Description copied from interface: Templates

Create a template in the account.

Specified by:

createTemplate in interface Templates

Parameters:

accountId - The account ID

attributes - A map of attributes to contruct the template

Returns:

The create template response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

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

updateTemplate

public UpdateTemplateResponse updateTemplate(String accountId,
                                             String templateId,
                                             Map<String,Object> attributes)
                                      throws DnsimpleException,
                                             IOException

Description copied from interface: Templates

Update a template in the account.

Specified by:

updateTemplate in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

attributes - A map of attributes to update the template

Returns:

The update template response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

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

deleteTemplate

public DeleteTemplateResponse deleteTemplate(String accountId,
                                             String templateId)
                                      throws DnsimpleException,
                                             IOException

Description copied from interface: Templates

Delete a template from the account.

Specified by:

deleteTemplate in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

Returns:

The delete template response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

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

applyTemplate

public ApplyTemplateResponse applyTemplate(String accountId,
                                           String templateId,
                                           String domainId)
                                    throws DnsimpleException,
                                           IOException

Description copied from interface: Templates

Apply a template from the account to the domain

Specified by:

applyTemplate in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

domainId - The domain ID

Returns:

The apply template response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/templates/#apply

listTemplateRecords

public ListTemplateRecordsResponse listTemplateRecords(String accountId,
                                                       String templateId)
                                                throws DnsimpleException,
                                                       IOException

Description copied from interface: Templates

Lists the records in the template.

Specified by:

listTemplateRecords in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

Returns:

The list template records response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/templates/records#list

listTemplateRecords

public ListTemplateRecordsResponse listTemplateRecords(String accountId,
                                                       String templateId,
                                                       Map<String,Object> options)
                                                throws DnsimpleException,
                                                       IOException

Description copied from interface: Templates

Lists the records in the template.

Specified by:

listTemplateRecords in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

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

Returns:

The list template records response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/templates/records#list

getTemplateRecord

public GetTemplateRecordResponse getTemplateRecord(String accountId,
                                                   String templateId,
                                                   String recordId)
                                            throws DnsimpleException,
                                                   IOException

Description copied from interface: Templates

Get a specific record associated to a template using the record's ID.

Specified by:

getTemplateRecord in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

recordId - The record ID

Returns:

The get template record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/templates/records/#get

createTemplateRecord

public CreateTemplateRecordResponse createTemplateRecord(String accountId,
                                                         String templateId,
                                                         Map<String,Object> attributes)
                                                  throws DnsimpleException,
                                                         IOException

Description copied from interface: Templates

Create a record in the template.

Specified by:

createTemplateRecord in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

attributes - A map of attributes to contruct the template record

Returns:

The create template record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/templates/records#create

deleteTemplateRecord

public DeleteTemplateRecordResponse deleteTemplateRecord(String accountId,
                                                         String templateId,
                                                         String recordId)
                                                  throws DnsimpleException,
                                                         IOException

Description copied from interface: Templates

Delete a record from the template.

Specified by:

deleteTemplateRecord in interface Templates

Parameters:

accountId - The account ID

templateId - The template ID

recordId - The record ID

Returns:

The delete template record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/templates/records#delete