Class: Textmagic::REST::Numbers

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

Instance Method Summary collapse

Methods inherited from ListResource

#create, #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

#available(params = {}) ⇒ Object

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'}



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

def available(params={})
  response = @client.get "#{@path}/available", params
  AvailableNumber.new "#{@path}", @client, response
end

#buy(params = {}) ⇒ Object

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}



74
75
76
 
# File 'lib/textmagic-ruby/rest/numbers.rb', line 74

def buy(params={})
  self.create params
end

#delete(uid) ⇒ Object

Cancel dedicated number subscription. Returns true if success.

uid

Number ID. Required.

Example:

r = client.numbers.delete 1290



94
95
96
 
# File 'lib/textmagic-ruby/rest/numbers.rb', line 94

def delete(uid)
  super uid
end

#get(uid) ⇒ Object

Get number by ID. Returns Number object.

uid

Number ID. Required.

Example:

@number = client.numbers.get 1123



14
15
16
 
# File 'lib/textmagic-ruby/rest/numbers.rb', line 14

def get(uid)
  super uid
end

#list(params = {}) ⇒ Object

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



32
33
34
35
36
37
 
# File 'lib/textmagic-ruby/rest/numbers.rb', line 32

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

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

Updating is not supported



81
82
83
 
# File 'lib/textmagic-ruby/rest/numbers.rb', line 81

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