Module: Dnsimple::Client::Templates

Included in:

TemplatesService

Defined in:

lib/dnsimple/client/templates.rb

Instance Method Summary

• #all_templates(account_id, options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Template> (also: #all)

  Lists ALL the templates in the account.

• #create_template(account_id, attributes, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Template> (also: #create)

  Creates a template in the account.

• #delete_template(account_id, template_id, options = {}) ⇒ Dnsimple::Response<nil> (also: #delete)

  Deletes a template from the account.

• #template(account_id, template_id, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Template>

  Gets the template with specified ID.

• #templates(account_id, options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Template> (also: #list, #list_templates)

  Lists the templates in the account.

• #update_template(account_id, template_id, attributes, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Template> (also: #update)

  Updates template with specified ID with provided data.

Instance Method Details

#all_templates(account_id, options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Template> Also known as: all

Lists ALL the templates in the account.

This method is similar to #templates, but instead of returning the results of a specific page it iterates all the pages and returns the entire collection.

Please use this method carefully, as fetching the entire collection will increase the number of requests you send to the API server and you may eventually risk to hit the throttle limit.

Examples:

List all the templates for account 1010:

client.templates.all_templates(1010)

Options Hash (options):

• :page (Integer) —

  current page (pagination)

• :per_page (Integer) —

  number of entries to return (pagination)

• :sort (String) —

  sorting policy

Raises:

• (RequestError) —

  When the request fails.

See Also:

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

# File 'lib/dnsimple/client/templates.rb', line 57

def all_templates(account_id, options = {})
  paginate(:templates, account_id, options)
end

#create_template(account_id, attributes, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Template> Also known as: create

Creates a template in the account.

Examples:

Creating a template:

client.templates.create_template(1010, name: "Pi", short_name: "pi", description: "Pi template")

Raises:

• (Dnsimple::RequestError)

See Also:

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

# File 'lib/dnsimple/client/templates.rb', line 75

def create_template(account_id, attributes, options = {})
  endpoint = Client.versioned("/%s/templates" % [account_id])
  response = client.post(endpoint, attributes, options)

  Dnsimple::Response.new(response, Struct::Template.new(response["data"]))
end

#delete_template(account_id, template_id, options = {}) ⇒ Dnsimple::Response<nil> Also known as: delete

Deletes a template from the account.

WARNING: this cannot be undone.

Examples:

Delete template 5401 in account 1010:

client.templates.delete_template(1010, 5401)

Raises:

• (Dnsimple::NotFoundError)
• (Dnsimple::RequestError)

See Also:

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

# File 'lib/dnsimple/client/templates.rb', line 141

def delete_template(account_id, template_id, options = {})
  endpoint = Client.versioned("/%s/templates/%s" % [account_id, template_id])
  response = client.delete(endpoint, options)

  Dnsimple::Response.new(response, nil)
end

#template(account_id, template_id, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Template>

Gets the template with specified ID.

Examples:

Get template 5401 in account 1010:

client.templates.template(1010, 5401)

Raises:

• (RequestError) —

  When the request fails.

See Also:

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

# File 'lib/dnsimple/client/templates.rb', line 96

def template(account_id, template_id, options = {})
  endpoint = Client.versioned("/%s/templates/%s" % [account_id, template_id])
  response = client.get(endpoint, options)

  Dnsimple::Response.new(response, Struct::Template.new(response["data"]))
end

#templates(account_id, options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Template> Also known as: list, list_templates

Lists the templates in the account.

Examples:

List the templates for account 1010:

client.templates.list_templates(1010)

List the templates for account 1010, provide a specific page:

client.templates.list_templates(1010, page: 2)

List the templates for account 1010, provide sorting policy:

client.templates.list_templates(1010, sort: "short_name:asc")

Options Hash (options):

• :page (Integer) —

  current page (pagination)

• :per_page (Integer) —

  number of entries to return (pagination)

• :sort (String) —

  sorting policy

Raises:

• (RequestError) —

  When the request fails.

See Also:

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

# File 'lib/dnsimple/client/templates.rb', line 26

def templates(account_id, options = {})
  endpoint = Client.versioned("/%s/templates" % [account_id])
  response = client.get(endpoint, Options::ListOptions.new(options))

  Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Template.new(r) })
end

#update_template(account_id, template_id, attributes, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Template> Also known as: update

Updates template with specified ID with provided data.

Examples:

Change the name of template 1 in account 1010:

client.templates.update_template(1010, 1, name: "New name")

Raises:

• (RequestError) —

  When the request fails.

See Also:

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

# File 'lib/dnsimple/client/templates.rb', line 117

def update_template(account_id, template_id, attributes, options = {})
  endpoint = Client.versioned("/%s/templates/%s" % [account_id, template_id])
  response = client.patch(endpoint, attributes, options)

  Dnsimple::Response.new(response, Struct::Template.new(response["data"]))
end