class Bandwidth::PhoneNumber

The Phone Numbers resource lets you get phone numbers for use with your programs and manage numbers you already have.

Public Class Methods

create(client, data) click to toggle source

Allocate a number so you can use it @param client [Client] optional client instance to make requests @param data [Hash] data about new number @return [PhoneNumber] created number information

# File lib/bandwidth/phone_number.rb, line 37
def self.create(client, data)
  headers = client.make_request(:post, client.concat_user_path(PHONENUMBER_PATH), data)[1]
  id = Client.get_id_from_location_header(headers[:location])
  self.get(client, id)
end
get(client, id) click to toggle source

Get information about one number @param client [Client] optional client instance to make requests @param id [String] id of phone number return [PhoneNumber] phone number information @example

number = PhoneNumber.get(client, "id")
# File lib/bandwidth/phone_number.rb, line 14
def self.get(client, id)
  item = client.make_request(:get, client.concat_user_path("#{PHONENUMBER_PATH}/#{id}"))[0]
  PhoneNumber.new(item, client)
end
list(client, query = nil) click to toggle source

Get a list of your numbers @param client [Client] optional client instance to make requests @param query [Hash] query options @return [Array] list of numbers @example

numbers = PhoneNumber.list(client)
# File lib/bandwidth/phone_number.rb, line 26
def self.list(client, query = nil)
  client.make_request(:get, client.concat_user_path(PHONENUMBER_PATH), query)[0].map do |item|
    PhoneNumber.new(item, client)
  end
end

Public Instance Methods

delete() click to toggle source

Removes a number from your account @example

number.delete()
# File lib/bandwidth/phone_number.rb, line 55
def delete()
  @client.make_request(:delete, @client.concat_user_path("#{PHONENUMBER_PATH}/#{id}"))[0]
end
Also aliased as: destroy
destroy()
Alias for: delete
update(data) click to toggle source

Make changes to a number you have @param data [Hash] changed data @example

number.update(:name => "name")
# File lib/bandwidth/phone_number.rb, line 48
def update(data)
  @client.make_request(:post, @client.concat_user_path("#{PHONENUMBER_PATH}/#{id}"), data)[0]
end