Class: Phoebe::Models::Ref::Taxonomy::EbirdRetrieveParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Resources::Ref::Taxonomy::Ebird#retrieve

Defined Under Namespace

Modules: Fmt

Instance Attribute Summary

• #cat ⇒ String^?

  Only fetch records from these taxonomic categories.

• #fmt ⇒ Symbol, ...

  Fetch the records in CSV or JSON format.

• #locale ⇒ String^?

  Use this language for common names.

• #species ⇒ String^?

  Only fetch records for these species.

• #version ⇒ String^?

  Fetch a specific version of the taxonomy.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(cat: nil, fmt: nil, locale: nil, species: nil, version: 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(cat: nil, fmt: nil, locale: nil, species: nil, version: nil, request_options: {}) ⇒ Object

Parameters:

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

  Only fetch records from these taxonomic categories.

• fmt (Symbol, Phoebe::Models::Ref::Taxonomy::EbirdRetrieveParams::Fmt) (defaults to: nil) —

  Fetch the records in CSV or JSON format.

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

  Use this language for common names.

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

  Only fetch records for these species.

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

  Fetch a specific version of the taxonomy.

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

# File 'lib/phoebe/models/ref/taxonomy/ebird_retrieve_params.rb', line 42

Instance Attribute Details

#cat ⇒ String^?

Only fetch records from these taxonomic categories.

Returns:

• (String, nil)

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

optional :cat, String

#fmt ⇒ Symbol, ...

Fetch the records in CSV or JSON format.

Returns:

• (Symbol, Phoebe::Models::Ref::Taxonomy::EbirdRetrieveParams::Fmt, nil)

# File 'lib/phoebe/models/ref/taxonomy/ebird_retrieve_params.rb', line 22

optional :fmt, enum: -> { Phoebe::Ref::Taxonomy::EbirdRetrieveParams::Fmt }

#locale ⇒ String^?

Use this language for common names.

Returns:

• (String, nil)

# File 'lib/phoebe/models/ref/taxonomy/ebird_retrieve_params.rb', line 28

optional :locale, String

#species ⇒ String^?

Only fetch records for these species.

Returns:

• (String, nil)

# File 'lib/phoebe/models/ref/taxonomy/ebird_retrieve_params.rb', line 34

optional :species, String

#version ⇒ String^?

Fetch a specific version of the taxonomy.

Returns:

• (String, nil)

# File 'lib/phoebe/models/ref/taxonomy/ebird_retrieve_params.rb', line 40

optional :version, String