Class: Phoebe::Models::Product::Top100RetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/phoebe/models/product/top100_retrieve_params.rb

Overview

See Also:

Defined Under Namespace

Modules: RankedBy

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(region_code:, y_:, m:, d:, max_results: nil, ranked_by: nil, request_options: {}) ⇒ Object

Parameters:

  • region_code (String)
  • y_ (Integer)
  • m (Integer)
  • d (Integer)
  • max_results (Integer) (defaults to: nil) —

    Only fetch this number of contributors.

  • ranked_by (Symbol, Phoebe::Models::Product::Top100RetrieveParams::RankedBy) (defaults to: nil) —

    Order by number of complete checklists (cl) or by number of species seen (spp).

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



# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 43

Instance Attribute Details

#d ⇒ Integer

Returns:

  • (Integer) 


29
 
# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 29

required :d, Integer

#m ⇒ Integer

Returns:

  • (Integer) 


24
 
# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 24

required :m, Integer

#max_results ⇒ Integer?

Only fetch this number of contributors.

Returns:

  • (Integer, nil) 


35
 
# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 35

optional :max_results, Integer

#ranked_by ⇒ Symbol, ...

Order by number of complete checklists (cl) or by number of species seen (spp).

Returns:



41
 
# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 41

optional :ranked_by, enum: -> { Phoebe::Product::Top100RetrieveParams::RankedBy }

#region_code ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 14

required :region_code, String

#y_ ⇒ Integer

Returns:

  • (Integer) 


19
 
# File 'lib/phoebe/models/product/top100_retrieve_params.rb', line 19

required :y_, Integer