Class: Textmagic::REST::Bulks

Inherits:
ListResource show all
Defined in:
lib/textmagic-ruby/rest/bulks.rb

Instance Method Summary collapse

Methods inherited from ListResource

#initialize, #inspect

Methods included from Utils

#key_map, #resource, #to_camel_case, #to_underscore_case

Constructor Details

This class inherits a constructor from Textmagic::REST::ListResource

Instance Method Details

#create(params = {}) ⇒ Object

Creating is not supported.



39
40
41
 
# File 'lib/textmagic-ruby/rest/bulks.rb', line 39

def create(params={})
  raise '`create` method is not supported for this resource.'
end

#delete(uid) ⇒ Object

Deleting is not supported.



53
54
55
 
# File 'lib/textmagic-ruby/rest/bulks.rb', line 53

def delete(uid)
  raise '`delete` method is not supported for this resource.'
end

#get(uid) ⇒ Object

Get bulks session by ID.

uid

Bulk session ID. Required.

Example:

@bulks = client.bulks.get 111



13
14
15
 
# File 'lib/textmagic-ruby/rest/bulks.rb', line 13

def get(uid)
  super
end

#list(params = {}) ⇒ Object

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



29
30
31
32
33
34
 
# File 'lib/textmagic-ruby/rest/bulks.rb', line 29

def list(params={})
  [:search, 'search'].each do |search|
    params.delete search
  end
  super params
end

#update(uid, params = {}) ⇒ Object

Updating is not supported.



46
47
48
 
# File 'lib/textmagic-ruby/rest/bulks.rb', line 46

def update(uid, params={})
  raise '`update` method is not supported for this resource.'
end