class Textmagic::REST::Replies
Public Instance Methods
create(params)
click to toggle source
Creating is not supported
# File lib/textmagic-ruby/rest/replies.rb 58 def create(params) 59 raise '`create` method is not supported for this resource' 60 end
delete(uid)
click to toggle source
Delete reply by ID. Returns true if success.
- uid
-
Reply
ID. Required.
Example:
r = client.replies.delete 28919
Calls superclass method
Textmagic::REST::ListResource#delete
# File lib/textmagic-ruby/rest/replies.rb 51 def delete(uid) 52 super uid 53 end
get(uid)
click to toggle source
Get reply by ID. Returns Reply
object.
- uid
-
Reply
ID. Required.
Example:
@reply = client.replies.get 19011
Calls superclass method
Textmagic::REST::ListResource#get
# File lib/textmagic-ruby/rest/replies.rb 14 def get(uid) 15 super uid 16 end
list(params={})
click to toggle source
Get all user replies. Returns PaginateResource
object, contains array of Reply
objects.
The following params keys are supported:
- search
-
If true then search replies using `ids` and/or `query`. Defaults false.
- page
-
Fetch specified results page. Defaults 1
- limit
-
How many results on page. Defaults 10
- ids
-
Find replies by ID(s). Using with `search`=true.
- query
-
Find replies by specified search query. Using with `search`=true..
Example:
@replies = client.replies.list
Calls superclass method
Textmagic::REST::ListResource#list
# File lib/textmagic-ruby/rest/replies.rb 38 def list(params={}) 39 super params 40 end
update(uid, params)
click to toggle source
Updating is not supported
# File lib/textmagic-ruby/rest/replies.rb 65 def update(uid, params) 66 raise '`update` method is not supported for this resource' 67 end