Class: Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/phoebe/models/ref/taxonomy/species_group_list_params.rb

Overview

See Also:

• Resources::Ref::Taxonomy::SpeciesGroups#list

Defined Under Namespace

Modules: SpeciesGrouping

Instance Attribute Summary

• #group_name_locale ⇒ String^?

  Locale for species group names.

• #species_grouping ⇒ Symbol, Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping

  The order in which groups are returned.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(species_grouping:, group_name_locale: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see SpeciesGroupListParams for more details.

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(species_grouping:, group_name_locale: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  The order in which groups are returned.

• group_name_locale (String) (defaults to: nil) —

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

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

# File 'lib/phoebe/models/ref/taxonomy/species_group_list_params.rb', line 25

Instance Attribute Details

#group_name_locale ⇒ String^?

Locale for species group names. English names are returned for any non-listed locale or any non-translated group name.

Returns:

• (String, nil)

# File 'lib/phoebe/models/ref/taxonomy/species_group_list_params.rb', line 23

optional :group_name_locale, String

#species_grouping ⇒ Symbol, Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping

The order in which groups are returned.

Returns:

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

# File 'lib/phoebe/models/ref/taxonomy/species_group_list_params.rb', line 16

required :species_grouping, enum: -> { Phoebe::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping }