class Textmagic::REST::Templates
Public Instance Methods
Create new Template
. Returns Template
object contains id and link to new Template
.
The following params keys are supported:
Example:
@template = client.templates.create {:name => 'MyTemplate'}
Textmagic::REST::ListResource#create
# File lib/textmagic-ruby/rest/templates.rb 32 def create(params={}) 33 super params 34 end
Delete template by ID. Returns true if success.
- uid
-
Template
ID. Required.
Example:
r = client.templates.delete 987
Textmagic::REST::ListResource#delete
# File lib/textmagic-ruby/rest/templates.rb 89 def delete(uid) 90 super uid 91 end
Get template by ID. Returns Template
object.
- uid
-
Template
ID. Required.
Example:
@template = client.templates.get 987
Textmagic::REST::ListResource#get
# File lib/textmagic-ruby/rest/templates.rb 14 def get(uid) 15 super uid 16 end
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
Textmagic::REST::ListResource#list
# File lib/textmagic-ruby/rest/templates.rb 56 def list(params={}) 57 super params 58 end
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:
Example:
@template = client.templates.update 123, {:name => 'Updated Template'}
Textmagic::REST::ListResource#update
# File lib/textmagic-ruby/rest/templates.rb 76 def update(uid, params={}) 77 super uid, params 78 end