class Textmagic::REST::Senderids
Public Instance Methods
create(params={})
click to toggle source
Create new Senderid
. Returns Senderid
object contains id and link to new Senderid
.
The following params keys are supported:
- sender_id
-
Alphanumeric Sender ID (maximum 11 characters). Required.
- explanation
-
Explain why do you need this Sender ID. Required.
Example:
@senderid = client.senderids.create {:sender_id => 'MYSENDERID', :explanation => 'For Testing'}
Calls superclass method
Textmagic::REST::ListResource#create
# File lib/textmagic-ruby/rest/senderids.rb 32 def create(params={}) 33 super params 34 end
delete(uid)
click to toggle source
Delete senderid by ID. Returns true if success.
- uid
-
Senderid
ID. Required.
Example:
r = client.senderids.delete 192881
Calls superclass method
Textmagic::REST::ListResource#delete
# File lib/textmagic-ruby/rest/senderids.rb 73 def delete(uid) 74 super uid 75 end
get(uid)
click to toggle source
Get senderid by ID. Returns Senderid
object.
- uid
-
Senderid
ID. Required.
Example:
@senderid = client.senderids.get 1123
Calls superclass method
Textmagic::REST::ListResource#get
# File lib/textmagic-ruby/rest/senderids.rb 14 def get(uid) 15 super uid 16 end
list(params={})
click to toggle source
Get all user sender ids. Returns PaginateResource
object, contains array of Senderid
objects.
The following params keys are supported:
- page
-
Fetch specified results page. Defaults 1
- limit
-
How many results on page. Defaults 10
Example:
@senderids = client.senderids.list
Calls superclass method
Textmagic::REST::ListResource#list
# File lib/textmagic-ruby/rest/senderids.rb 50 def list(params={}) 51 [:search, 'search'].each do |search| 52 params.delete search 53 end 54 super params 55 end
update(uid, params={})
click to toggle source
Updating is not supported.
# File lib/textmagic-ruby/rest/senderids.rb 60 def update(uid, params={}) 61 raise '`update` method is not supported for this resource.' 62 end