Class: Phoebe::Resources::Ref::Hotspot::Geo

Inherits:

Object

• Object
• Phoebe::Resources::Ref::Hotspot::Geo

Defined in:

lib/phoebe/resources/ref/hotspot/geo.rb

Overview

With the ref/hotspot end-points you can find the hotspots for a given country or region or nearby hotspots

Instance Method Summary

• #initialize(client:) ⇒ Geo constructor private

  A new instance of Geo.

• #retrieve(lat:, lng:, back: nil, dist: nil, fmt: nil, request_options: {}) ⇒ Array<Phoebe::Models::Ref::Hotspot::GeoRetrieveResponseItem>

  Get the list of hotspots, within a radius of up to 50 kilometers, from a given set of coordinates.

Constructor Details

#initialize(client:) ⇒ Geo

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Geo.

Parameters:

• client (Phoebe::Client)

# File 'lib/phoebe/resources/ref/hotspot/geo.rb', line 45

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(lat:, lng:, back: nil, dist: nil, fmt: nil, request_options: {}) ⇒ Array<Phoebe::Models::Ref::Hotspot::GeoRetrieveResponseItem>

Get the list of hotspots, within a radius of up to 50 kilometers, from a given set of coordinates.

Parameters:

• lat (Float)
• lng (Float)
• back (Integer) —

  The number of days back to fetch hotspots.

• dist (Integer) —

  The search radius from the given position, in kilometers.

• fmt (Symbol, Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::Fmt) —

  Fetch the records in CSV or JSON format.

• request_options (Phoebe::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Array<Phoebe::Models::Ref::Hotspot::GeoRetrieveResponseItem>)

See Also:

• Models::Ref::Hotspot::GeoRetrieveParams

# File 'lib/phoebe/resources/ref/hotspot/geo.rb', line 30

def retrieve(params)
  parsed, options = Phoebe::Ref::Hotspot::GeoRetrieveParams.dump_request(params)
  query = Phoebe::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ref/hotspot/geo",
    query: query,
    model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::Hotspot::GeoRetrieveResponseItem],
    options: options
  )
end