com.dnsimple

Interface Templates

All Known Implementing Classes:

TemplatesEndpoint

public interface Templates

Provides access to the DNSimple Templates API.

See Also:

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

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.

Method Detail

listTemplates

ListTemplatesResponse listTemplates(String accountId)
                             throws DnsimpleException,
                                    IOException

Lists the templates in the account.

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

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

Lists the templates in the account.

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

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

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

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

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

Create a template in the account.

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

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

Update a template in the account.

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

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

Delete a template from the account.

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

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

Apply a template from the account to the domain

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

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

Lists the records in the template.

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

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

Lists the records in the template.

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

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

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

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

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

Create a record in the template.

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

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

Delete a record from the template.

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