Class: Phoebe::Models::Ref::Hotspot::GeoRetrieveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Phoebe::Models::Ref::Hotspot::GeoRetrieveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb

Overview

See Also:

• Resources::Ref::Hotspot::Geo#retrieve

Defined Under Namespace

Modules: Fmt

Instance Attribute Summary

• #back ⇒ Integer^?

  The number of days back to fetch hotspots.

• #dist ⇒ Integer^?

  The search radius from the given position, in kilometers.

• #fmt ⇒ Symbol, ...

  Fetch the records in CSV or JSON format.

• #lat ⇒ Float
• #lng ⇒ Float

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(lat:, lng:, back: nil, dist: nil, fmt: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(lat:, lng:, back: nil, dist: nil, fmt: nil, request_options: {}) ⇒ Object

Parameters:

• lat (Float)
• lng (Float)
• back (Integer) (defaults to: nil) —

  The number of days back to fetch hotspots.

• dist (Integer) (defaults to: nil) —

  The search radius from the given position, in kilometers.

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

  Fetch the records in CSV or JSON format.

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

# File 'lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb', line 40

Instance Attribute Details

#back ⇒ Integer^?

The number of days back to fetch hotspots.

Returns:

• (Integer, nil)

# File 'lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb', line 26

optional :back, Integer

#dist ⇒ Integer^?

The search radius from the given position, in kilometers.

Returns:

• (Integer, nil)

# File 'lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb', line 32

optional :dist, Integer

#fmt ⇒ Symbol, ...

Fetch the records in CSV or JSON format.

Returns:

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

# File 'lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb', line 38

optional :fmt, enum: -> { Phoebe::Ref::Hotspot::GeoRetrieveParams::Fmt }

#lat ⇒ Float

Returns:

• (Float)

# File 'lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb', line 15

required :lat, Float

#lng ⇒ Float

Returns:

• (Float)

# File 'lib/phoebe/models/ref/hotspot/geo_retrieve_params.rb', line 20

required :lng, Float