Class: Plivo::Resources::Numbers

Inherits:

Base::Resource

• Object
• Base::Resource
• Plivo::Resources::Numbers

Defined in:

lib/plivo/resources/powerpacks.rb

Constant Summary

Constants included from Utils

Utils::TYPE_WHITELIST

Instance Attribute Summary

Attributes inherited from Base::Resource

#id

Instance Method Summary

• #add(number) ⇒ Object
• #buy_add_number(options = nil) ⇒ Object
• #count(options = nil) ⇒ Object
• #find(number) ⇒ Object
• #initialize(client, options = nil) ⇒ Numbers constructor

  A new instance of Numbers.

• #list(options = nil) ⇒ Object
• #remove(number, unrent = false) ⇒ Object

Methods included from Utils

expected_type?, expected_value?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_subaccount?

Constructor Details

#initialize(client, options = nil) ⇒ Numbers

Returns a new instance of Numbers.

# File 'lib/plivo/resources/powerpacks.rb', line 324

def initialize(client, options = nil)
  @_name = 'Numbers'
  @_identifier_string = 'number_pool_id'
  super
end

Instance Method Details

#add(number) ⇒ Object

# File 'lib/plivo/resources/powerpacks.rb', line 415

def add(number)
  perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
               'POST')
end

#buy_add_number(options = nil) ⇒ Object

# File 'lib/plivo/resources/powerpacks.rb', line 425

def buy_add_number(options = nil)
  params = {}
  params[:rent] = true
  if options.key?(:number)
    return perform_custom_action_apiresponse('NumberPool/' + number_pool_id + '/Number/' + options[:number].to_s ,
               'POST', params)
  end
  if options.key?(:country_iso2).nil?
    raise_invalid_request('country_iso is cannot be empty')
  end
  params = {}
  
  %i[offset limit].each do |param|
    if options.key?(param) && valid_param?(param, options[param],
                                           [Integer, Integer], true)
      params[param] = options[param]
    end
  end
  
  if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
    raise_invalid_request('The maximum number of results that can be '\
    "fetched is 20. limit can't be more than 20 or less than 1")
  end
  
  if options.key?(:offset) && options[:offset] < 0
    raise_invalid_request("Offset can't be negative")
  end

  if options.key?(:pattern) &&
    valid_param?(:pattern, options[:pattern], String, true)
   params[:starts_with] = options[:pattern]
  end
  if options.key?(:country_iso2) &&
    valid_param?(:country_iso2, options[:country_iso2], String, true)
   params[:country_iso] = options[:country_iso2]
  end
  if options.key?(:type) &&
    valid_param?(:type, options[:type], String, true)
   params[:type] = options[:type]
  end

 response = perform_custom_action_apiresponse('PhoneNumber',
 'GET', params, true)
  numbers = response['objects'][0]['number']
  params[:rent] = true
  perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + numbers.to_s,
               'POST', params)
end

#count(options = nil) ⇒ Object

# File 'lib/plivo/resources/powerpacks.rb', line 366

def count(options = nil)
  if options.nil?
   response = perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number',
   'GET')
   meta = response['meta']
   return meta['total_count']
  end
 
  params = {}
  
  %i[offset limit].each do |param|
    if options.key?(param) && valid_param?(param, options[param],
                                           [Integer, Integer], true)
      params[param] = options[param]
    end
  end
  
  if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
    raise_invalid_request('The maximum number of results that can be '\
    "fetched is 20. limit can't be more than 20 or less than 1")
  end
  
  if options.key?(:offset) && options[:offset] < 0
    raise_invalid_request("Offset can't be negative")
  end

  if options.key?(:pattern) &&
    valid_param?(:pattern, options[:pattern], String, true)
   params[:starts_with] = options[:pattern]
  end
  if options.key?(:country_iso2) &&
    valid_param?(:country_iso2, options[:country_iso2], String, true)
   params[:country_iso2] = options[:country_iso2]
  end
  if options.key?(:type) &&
    valid_param?(:type, options[:type], String, true)
   params[:type] = options[:type]
  end
  response = perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number',
  'GET', params, true)
  meta = response['meta']
  return meta['total_count']
end

#find(number) ⇒ Object

# File 'lib/plivo/resources/powerpacks.rb', line 410

def find(number)
  perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
               'GET')
end

#list(options = nil) ⇒ Object

# File 'lib/plivo/resources/powerpacks.rb', line 330

def list(options = nil)
  return perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number',
  'GET') if options.nil?

  params = {}
  %i[offset limit].each do |param|
    if options.key?(param) && valid_param?(param, options[param],
                                           [Integer, Integer], true)
      params[param] = options[param]
    end
  end
  
  if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
    raise_invalid_request('The maximum number of results that can be '\
    "fetched is 20. limit can't be more than 20 or less than 1")
  end
  
  if options.key?(:offset) && options[:offset] < 0
    raise_invalid_request("Offset can't be negative")
  end

  if options.key?(:pattern) &&
    valid_param?(:pattern, options[:pattern], String, true)
   params[:starts_with] = options[:pattern]
  end
  if options.key?(:country_iso2) &&
    valid_param?(:country_iso2, options[:country_iso2], String, true)
   params[:country_iso2] = options[:country_iso2]
  end
  if options.key?(:type) &&
    valid_param?(:type, options[:type], String, true)
   params[:type] = options[:type]
  end
  perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number',
  'GET', params, true)
end

#remove(number, unrent = false) ⇒ Object

# File 'lib/plivo/resources/powerpacks.rb', line 420

def remove(number, unrent= false)
  perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
               'DELETE', { unrent: unrent }, false)
end