Class: Phoebe::Resources::Product::Lists::Historical

Inherits:
Object
  • Object
show all
Defined in:
lib/phoebe/resources/product/lists/historical.rb

Overview

The product end-points make it easy to get the information shown in various pages on the eBird web site: 1. The Top 100 contributors on a given date. 2. The checklists submitted on a given date. 3. The most recent checklists submitted. 4. A summary of the checklists submitted on a given date. 5. The details and all the observations of a checklist.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Historical

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

Parameters:



65
66
67
 
# File 'lib/phoebe/resources/product/lists/historical.rb', line 65

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(d, region_code:, y_:, m:, max_results: nil, sort_key: nil, request_options: {}) ⇒ Array<Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem>

Some parameter documentations has been truncated, see Models::Product::Lists::HistoricalRetrieveParams for more details.

Get information on the checklists submitted on a given date for a country or region.

Parameters:

  • d (Integer) —

    Path param: The day in the month.

  • region_code (String) —

    Path param: The country, subnational1, subnational2 or location code.

  • y_ (Integer) —

    Path param: The year, from 1800 to the present.

  • m (Integer) —

    Path param: The month, from 1-12.

  • max_results (Integer) —

    Query param: Only fetch this number of checklists.

  • sort_key (Symbol, Phoebe::Models::Product::Lists::HistoricalRetrieveParams::SortKey) —

    Query param: Order the results by the date of the checklist or by the date it wa

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

Returns:

See Also:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/phoebe/resources/product/lists/historical.rb', line 38

def retrieve(d, params)
  parsed, options = Phoebe::Product::Lists::HistoricalRetrieveParams.dump_request(params)
  query = Phoebe::Internal::Util.encode_query_params(parsed)
  region_code =
    parsed.delete(:region_code) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  y_ =
    parsed.delete(:y_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  m =
    parsed.delete(:m) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["product/lists/%1$s/%2$s/%3$s/%4$s", region_code, y_, m, d],
    query: query.transform_keys(max_results: "maxResults", sort_key: "sortKey"),
    model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem],
    options: options
  )
end