Module: Dnsimple::Client::Templates

Included in:
TemplatesService
Defined in:
lib/dnsimple/client/templates.rb

Instance Method Summary collapse

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)

Parameters:

  • account_id (Fixnum) —

    the account ID

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



45
46
47
 
# File 'lib/dnsimple/client/templates.rb', line 45

def all_templates(, options = {})
  paginate(:templates, , 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")

Parameters:

  • account_id (Fixnum) —

    the account ID

  • attributes (Hash)
  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



63
64
65
66
67
68
 
# File 'lib/dnsimple/client/templates.rb', line 63

def create_template(, attributes, options = {})
  endpoint = Client.versioned("/%s/templates" % [])
  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)

Parameters:

  • account_id (Fixnum) —

    The account ID

  • template_id (#to_s) —

    The template ID

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



129
130
131
132
133
134
 
# File 'lib/dnsimple/client/templates.rb', line 129

def delete_template(, template_id, options = {})
  endpoint = Client.versioned("/%s/templates/%s" % [, 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)

Parameters:

  • account_id (Fixnum) —

    the account ID

  • template_id (#to_s) —

    The template ID

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



84
85
86
87
88
89
 
# File 'lib/dnsimple/client/templates.rb', line 84

def template(, template_id, options = {})
  endpoint = Client.versioned("/%s/templates/%s" % [, 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)

Parameters:

  • account_id (Fixnum) —

    the account ID

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



17
18
19
20
21
22
 
# File 'lib/dnsimple/client/templates.rb', line 17

def templates(, options = {})
  endpoint = Client.versioned("/%s/templates" % [])
  response = client.get(endpoint, 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")

Parameters:

  • account_iduthe (Fixnum) —

    account ID

  • template_id (#to_s) —

    The template ID

  • attributes (Hash)
  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



105
106
107
108
109
110
 
# File 'lib/dnsimple/client/templates.rb', line 105

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

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