class Textmagic::REST::Bulks
Public Instance Methods
create(params={})
click to toggle source
Creating is not supported.
# File lib/textmagic-ruby/rest/bulks.rb 39 def create(params={}) 40 raise '`create` method is not supported for this resource.' 41 end
delete(uid)
click to toggle source
Deleting is not supported.
# File lib/textmagic-ruby/rest/bulks.rb 53 def delete(uid) 54 raise '`delete` method is not supported for this resource.' 55 end
get(uid)
click to toggle source
Get bulks session by ID.
- uid
-
Bulk
session ID. Required.
Example:
@bulks = client.bulks.get 111
Calls superclass method
# File lib/textmagic-ruby/rest/bulks.rb 13 def get(uid) 14 super 15 end
list(params={})
click to toggle source
Get all bulk sending sessions.
The following params keys are supported:
- page
-
Fetch specified results page. Defaults 1
- limit
-
How many results on page. Defaults 10
Example:
@bulks = client.bulks.list
Calls superclass method
# File lib/textmagic-ruby/rest/bulks.rb 29 def list(params={}) 30 [:search, 'search'].each do |search| 31 params.delete search 32 end 33 super params 34 end
update(uid, params={})
click to toggle source
Updating is not supported.
# File lib/textmagic-ruby/rest/bulks.rb 46 def update(uid, params={}) 47 raise '`update` method is not supported for this resource.' 48 end