Class: Phoebe::Resources::Ref::Taxonomy::SpeciesGroups

Inherits:

Object

• Object
• Phoebe::Resources::Ref::Taxonomy::SpeciesGroups

Defined in:

lib/phoebe/resources/ref/taxonomy/species_groups.rb

Instance Method Summary

• #initialize(client:) ⇒ SpeciesGroups constructor private

  A new instance of SpeciesGroups.

• #list(species_grouping, group_name_locale: nil, request_options: {}) ⇒ Array<Phoebe::Models::Ref::Taxonomy::SpeciesGroupListResponseItem>

  Some parameter documentations has been truncated, see Models::Ref::Taxonomy::SpeciesGroupListParams for more details.

Constructor Details

#initialize(client:) ⇒ SpeciesGroups

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 SpeciesGroups.

Parameters:

• client (Phoebe::Client)

# File 'lib/phoebe/resources/ref/taxonomy/species_groups.rb', line 41

def initialize(client:)
  @client = client
end

Instance Method Details

#list(species_grouping, group_name_locale: nil, request_options: {}) ⇒ Array<Phoebe::Models::Ref::Taxonomy::SpeciesGroupListResponseItem>

Some parameter documentations has been truncated, see Models::Ref::Taxonomy::SpeciesGroupListParams for more details.

Get the list of species groups, e.g. terns, finches, etc. #### Notes Merlin puts like birds together, with Falcons next to Hawks, whereas eBird follows taxonomic order.

Parameters:

• species_grouping (Symbol, Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping) —

  The order in which groups are returned.

• group_name_locale (String) —

  Locale for species group names. English names are returned for any non-listed lo

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

Returns:

• (Array<Phoebe::Models::Ref::Taxonomy::SpeciesGroupListResponseItem>)

See Also:

• Models::Ref::Taxonomy::SpeciesGroupListParams

# File 'lib/phoebe/resources/ref/taxonomy/species_groups.rb', line 26

def list(species_grouping, params = {})
  parsed, options = Phoebe::Ref::Taxonomy::SpeciesGroupListParams.dump_request(params)
  query = Phoebe::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["ref/sppgroup/%1$s", species_grouping],
    query: query.transform_keys(group_name_locale: "groupNameLocale"),
    model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::Taxonomy::SpeciesGroupListResponseItem],
    options: options
  )
end