Package com.dnsimple.endpoints

Class Templates

java.lang.Object

com.dnsimple.endpoints.Templates

public class Templates
extends Object

Provides access to the DNSimple Templates API.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
Templates(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
EmptyResponse	applyTemplate(Number account, String template, String domain)	Apply a template from the account to the domain
SimpleResponse<Template>	createTemplate(Number account, TemplateOptions options)	Create a template in the account.
SimpleResponse<TemplateRecord>	createTemplateRecord(Number account, String template, TemplateRecordOptions options)	Create a record in the template.
EmptyResponse	deleteTemplate(Number account, String template)	Delete a template from the account.
EmptyResponse	deleteTemplateRecord(Number account, String template, Number record)	Delete a record from the template.
SimpleResponse<Template>	getTemplate(Number account, String template)	Get a specific template associated to an account using the templates's ID.
SimpleResponse<TemplateRecord>	getTemplateRecord(Number account, String template, Number record)	Get a specific record associated to a template using the record's ID.
PaginatedResponse<TemplateRecord>	listTemplateRecords(Number account, String template)	Lists the records in the template.
PaginatedResponse<TemplateRecord>	listTemplateRecords(Number account, String template, ListOptions options)	Lists the records in the template.
PaginatedResponse<Template>	listTemplates(Number account)	Lists the templates in the account.
PaginatedResponse<Template>	listTemplates(Number account, ListOptions options)	Lists the templates in the account.
SimpleResponse<Template>	updateTemplate(Number account, String template, TemplateOptions options)	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 Details

Templates

public Templates(HttpEndpointClient client)

Method Details

listTemplates

public PaginatedResponse<Template> listTemplates(Number account)

Lists the templates in the account.

Parameters:

account - The account ID

Returns:

The list templates response

See Also:

• https://developer.dnsimple.com/v2/templates/#listTemplates

listTemplates

public PaginatedResponse<Template> listTemplates(Number account,
 ListOptions options)

Lists the templates in the account.

Parameters:

account - The account ID

options - The options for the list request

Returns:

The list templates response

See Also:

• https://developer.dnsimple.com/v2/templates/#listTemplates

createTemplate

public SimpleResponse<Template> createTemplate(Number account,
 TemplateOptions options)

Create a template in the account.

Parameters:

account - The account ID

options - The template options

Returns:

The create template response

See Also:

• https://developer.dnsimple.com/v2/templates/#createTemplate

getTemplate

public SimpleResponse<Template> getTemplate(Number account,
 String template)

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

Parameters:

account - The account ID

template - The template short name or ID

Returns:

The get template response

See Also:

• https://developer.dnsimple.com/v2/templates/#getTemplate

updateTemplate

public SimpleResponse<Template> updateTemplate(Number account,
 String template,
 TemplateOptions options)

Update a template in the account.

Parameters:

account - The account ID

template - The template short name or ID

options - The template options

Returns:

The update template response

See Also:

• https://developer.dnsimple.com/v2/templates/#updateTemplate

deleteTemplate

public EmptyResponse deleteTemplate(Number account,
 String template)

Delete a template from the account.

Parameters:

account - The account ID

template - The template short name or ID

Returns:

The delete template response

See Also:

• https://developer.dnsimple.com/v2/templates/#deleteTemplate

applyTemplate

public EmptyResponse applyTemplate(Number account,
 String template,
 String domain)

Apply a template from the account to the domain

Parameters:

account - The account ID

template - The template short name or ID

domain - The domain ID or name

Returns:

The apply template response

See Also:

• https://developer.dnsimple.com/v2/domains/templates/#applyTemplateToDomain

listTemplateRecords

public PaginatedResponse<TemplateRecord> listTemplateRecords(Number account,
 String template)

Lists the records in the template.

Parameters:

account - The account ID

template - The template short name or ID

Returns:

The list template records response

See Also:

• https://developer.dnsimple.com/v2/templates/records#listTemplateRecords

listTemplateRecords

public PaginatedResponse<TemplateRecord> listTemplateRecords(Number account,
 String template,
 ListOptions options)

Lists the records in the template.

Parameters:

account - The account ID

template - The template short name or ID

options - The options for the list request

Returns:

The list template records response

See Also:

• https://developer.dnsimple.com/v2/templates/records#listTemplateRecords

createTemplateRecord

public SimpleResponse<TemplateRecord> createTemplateRecord(Number account,
 String template,
 TemplateRecordOptions options)

Create a record in the template.

Parameters:

account - The account ID

template - The template short name or ID

options - The template record options

Returns:

The create template record response

See Also:

• https://developer.dnsimple.com/v2/templates/records#createTemplateRecord

getTemplateRecord

public SimpleResponse<TemplateRecord> getTemplateRecord(Number account,
 String template,
 Number record)

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

Parameters:

account - The account ID

template - The template short name or ID

record - The record ID

Returns:

The get template record response

See Also:

• https://developer.dnsimple.com/v2/templates/records/#getTemplateRecord

deleteTemplateRecord

public EmptyResponse deleteTemplateRecord(Number account,
 String template,
 Number record)

Delete a record from the template.

Parameters:

account - The account ID

template - The template short name or ID

record - The record ID

Returns:

The delete template record response

See Also:

• https://developer.dnsimple.com/v2/templates/records#deleteTemplateRecord