Class: Yelp::Fusion::Endpoint::Phone

Inherits:

Object

• Object
• Yelp::Fusion::Endpoint::Phone

Defined in:

lib/yelp/fusion/endpoint/phone.rb

Overview

Class to search businesses by phone

Constant Summary

PATH =

'/v3/businesses/search/phone'.freeze

Instance Method Summary

• #initialize(client) ⇒ Phone constructor

  A new instance of Phone.

• #phone_search(phone) ⇒ Response::Phone

  Make a request to the business endpoint on the API.

Constructor Details

#initialize(client) ⇒ Phone

Returns a new instance of Phone.

# File 'lib/yelp/fusion/endpoint/phone.rb', line 35

def initialize(client)
  @client = client
end

Instance Method Details

#phone_search(phone) ⇒ Response::Phone

Make a request to the business endpoint on the API

Examples:

Search for business with params and locale

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

Parameters:

• phone (String) —

  the phone number

Returns:

• (Response::Phone) —

  a parsed object of the response. For a complete sample response visit: www.yelp.com/developers/documentation/v3/business_search_phone

# File 'lib/yelp/fusion/endpoint/phone.rb', line 51

def phone_search(phone)
  phone_hash = { phone: phone }
  Responses::Phone.new(JSON.parse(phone_request(phone_hash).body))
end