Class: Yelp::Endpoint::PhoneSearch

Inherits:

Object

• Object
• Yelp::Endpoint::PhoneSearch

Defined in:

lib/yelp/endpoint/phone_search.rb

Constant Summary

PATH =

'/v2/phone_search/'

Instance Method Summary

• #initialize(client) ⇒ PhoneSearch constructor

  A new instance of PhoneSearch.

• #phone_search(phone, options = {}) ⇒ Response::PhoneSearch

  Make a request to the business endpoint on the API.

Constructor Details

#initialize(client) ⇒ PhoneSearch

Returns a new instance of PhoneSearch.

# File 'lib/yelp/endpoint/phone_search.rb', line 10

def initialize(client)
  @client = client
end

Instance Method Details

#phone_search(phone, options = {}) ⇒ Response::PhoneSearch

Make a request to the business endpoint on the API

Examples:

Search for business with params and locale

options = { code: 'US',
           category: 'localflavor' }

response = client.phone_search('+14159083801', options)
response.businesses # [<Business 1>, <Business 2>, <Business 3>]
response.businesses[0].name # 'Yelp'

Parameters:

• phone_number (String) —

  the phone number

Returns:

• (Response::PhoneSearch) —

  a parsed object of the response. For a complete sample response visit: www.yelp.com/developers/documentation/v2/phone_search#sampleResponse

# File 'lib/yelp/endpoint/phone_search.rb', line 29

def phone_search(phone, options={})
  params = {phone: phone}
  params.merge!(options)

  Response::PhoneSearch.new(JSON.parse(phone_search_request(params).body))
end