class Textmagic::REST::Unsubscribers

Public Instance Methods

create(params={}) click to toggle source

Unsubscribe phone from your communication by phone number. Returns Unsubscriber object contains id and link to new Unsubscriber.

The following params keys are supported:

phone

Phone number you want to unsubscribe. Required.

Example:

@unsubscriber = client.unsubscribers.create {:phone => '999920102'}
Calls superclass method Textmagic::REST::ListResource#create
   # File lib/textmagic-ruby/rest/unsubscribers.rb
30 def create(params={})
31   super params
32 end
delete(uid) click to toggle source

Deleting is not supported.

   # File lib/textmagic-ruby/rest/unsubscribers.rb
58 def delete(uid)
59   raise '`delete` method is not available for this type of resource.'
60 end
get(uid) click to toggle source

Get unsubscriber by ID. Returns Unsubscriber object.

uid

Unsubscriber ID. Required.

Example:

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

Get all user unsubscribers. Returns PaginateResource object, contains array of Unsubscriber objects.

The following params keys are supported:

page

Fetch specified results page. Defaults 1

limit

How many results on page. Defaults 10

Example:

@unsubscribers = client.unsubscribers.list
Calls superclass method Textmagic::REST::ListResource#list
   # File lib/textmagic-ruby/rest/unsubscribers.rb
48 def list(params={})
49   [:search, 'search'].each do |search|
50     params.delete search
51   end
52   super params
53 end
update(uid, params={}) click to toggle source

Updating is not supported.

   # File lib/textmagic-ruby/rest/unsubscribers.rb
65 def update(uid, params={})
66   raise '`update` method is not available for this type of resource.'
67 end