class Textmagic::REST::Numbers

Public Instance Methods

available(params={}) click to toggle source

Find available dedicated numbers to buy. Returns AvailableNumber object, contains array of available numbers and price.

The following params keys are supported:

country

Dedicated number country. Required.

prefix

Desired number prefix. Should include country code (i.e. 447 for GB).

Example:

@numbers = client.numbers.available {:country => 'US'}
   # File lib/textmagic-ruby/rest/numbers.rb
53 def available(params={})
54   response = @client.get "#{@path}/available", params
55   AvailableNumber.new "#{@path}", @client, response
56 end
buy(params={}) click to toggle source

Buy a dedicated number and assign it to the specified account. Returns Number object, contains id and link to a new dedicated Number.

The following params keys are supported:

phone

Desired dedicated phone number in international E.164 format. Required.

country

Dedicated number country. Required.

user_id

User ID this number will be assigned to. Required.

Example:

@number = client.numbers.buy {:phone => '19025555555', :country => 'US', :user_id => 1234}
   # File lib/textmagic-ruby/rest/numbers.rb
74 def buy(params={})
75   self.create params
76 end
delete(uid) click to toggle source

Cancel dedicated number subscription. Returns true if success.

uid

Number ID. Required.

Example:

r = client.numbers.delete 1290
Calls superclass method Textmagic::REST::ListResource#delete
   # File lib/textmagic-ruby/rest/numbers.rb
94 def delete(uid)
95   super uid
96 end
get(uid) click to toggle source

Get number by ID. Returns Number object.

uid

Number ID. Required.

Example:

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

Get all user dedicated numbers. Returns PaginateResource object, contains array of Numbers objects.

The following params keys are supported:

page

Fetch specified results page. Defaults 1

limit

How many results on page. Defaults 10

Example:

@numbers = client.numbers.list
Calls superclass method Textmagic::REST::ListResource#list
   # File lib/textmagic-ruby/rest/numbers.rb
32 def list(params={})
33   [:search, 'search'].each do |search|
34     params.delete search
35   end
36   super params
37 end
update(uid, params={}) click to toggle source

Updating is not supported

   # File lib/textmagic-ruby/rest/numbers.rb
81 def update(uid, params={})
82   raise '`update` method is not supported for this resource.'
83 end