class Textmagic::REST::Templates

Public Instance Methods

create(params={}) click to toggle source

Create new Template. Returns Template object contains id and link to new Template.

The following params keys are supported:

name

Template name. Required.

content

Template text. May contain tags inside braces. Required.

Example:

@template = client.templates.create {:name => 'MyTemplate'}
Calls superclass method Textmagic::REST::ListResource#create
   # File lib/textmagic-ruby/rest/templates.rb
32 def create(params={})
33   super params
34 end
delete(uid) click to toggle source

Delete template by ID. Returns true if success.

uid

Template ID. Required.

Example:

r = client.templates.delete 987
Calls superclass method Textmagic::REST::ListResource#delete
   # File lib/textmagic-ruby/rest/templates.rb
89 def delete(uid)
90   super uid
91 end
get(uid) click to toggle source

Get template by ID. Returns Template object.

uid

Template ID. Required.

Example:

@template = client.templates.get 987
Calls superclass method Textmagic::REST::ListResource#get
   # File lib/textmagic-ruby/rest/templates.rb
14 def get(uid)
15   super uid
16 end
list(params={}) click to toggle source

Get all user templates. Returns PaginateResource object, contains array of Template objects.

The following params keys are supported:

search

If true then search templates using `name` and/or `content`. Defaults false.

page

Fetch specified results page. Defaults 1

limit

How many results on page. Defaults 10

name

Find template by name. Using with `search`=true.

content

Find template by content. Using with `search`=true..

Example:

@templates = client.templates.list
Calls superclass method Textmagic::REST::ListResource#list
   # File lib/textmagic-ruby/rest/templates.rb
56 def list(params={})
57   super params
58 end
update(uid, params={}) click to toggle source

Updates the existing Template for the given unique id. Returns Template object contains id and link to updated Template.

uid

Template ID. Required.

The following params keys are supported:

name

Template name. Required.

content

Template text. May contain tags inside braces. Required.

Example:

@template = client.templates.update 123, {:name => 'Updated Template'}
Calls superclass method Textmagic::REST::ListResource#update
   # File lib/textmagic-ruby/rest/templates.rb
76 def update(uid, params={})
77   super uid, params
78 end