phoebe 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/lib/phoebe/models/ref/hotspot/info_retrieve_params.rb

@@ -9,7 +9,13 @@ module Phoebe
           extend Phoebe::Internal::Type::RequestParameters::Converter
           include Phoebe::Internal::Type::RequestParameters
 
-          # @!method initialize(request_options: {})
+          # @!attribute loc_id
+          #
+          #   @return [String]
+          required :loc_id, String
+
+          # @!method initialize(loc_id:, request_options: {})
+          #   @param loc_id [String]
           #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/phoebe/models/ref/hotspot_list_params.rb

@@ -8,6 +8,11 @@ module Phoebe
         extend Phoebe::Internal::Type::RequestParameters::Converter
         include Phoebe::Internal::Type::RequestParameters
 
+        # @!attribute region_code
+        #
+        #   @return [String]
+        required :region_code, String
+
         # @!attribute back
         #   The number of days back to fetch hotspots.
         #
@@ -20,7 +25,9 @@ module Phoebe
         #   @return [Symbol, Phoebe::Models::Ref::HotspotListParams::Fmt, nil]
         optional :fmt, enum: -> { Phoebe::Ref::HotspotListParams::Fmt }
 
-        # @!method initialize(back: nil, fmt: nil, request_options: {})
+        # @!method initialize(region_code:, back: nil, fmt: nil, request_options: {})
+        #   @param region_code [String]
+        #
         #   @param back [Integer] The number of days back to fetch hotspots.
         #
         #   @param fmt [Symbol, Phoebe::Models::Ref::HotspotListParams::Fmt] Fetch the records in CSV or JSON format.

data/lib/phoebe/models/ref/region/adjacent_list_params.rb

@@ -9,7 +9,13 @@ module Phoebe
           extend Phoebe::Internal::Type::RequestParameters::Converter
           include Phoebe::Internal::Type::RequestParameters
 
-          # @!method initialize(request_options: {})
+          # @!attribute region_code
+          #
+          #   @return [String]
+          required :region_code, String
+
+          # @!method initialize(region_code:, request_options: {})
+          #   @param region_code [String]
           #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/phoebe/models/ref/region/info_retrieve_params.rb

@@ -9,6 +9,11 @@ module Phoebe
           extend Phoebe::Internal::Type::RequestParameters::Converter
           include Phoebe::Internal::Type::RequestParameters
 
+          # @!attribute region_code
+          #
+          #   @return [String]
+          required :region_code, String
+
           # @!attribute delim
           #   The characters used to separate elements in the name.
           #
@@ -21,7 +26,9 @@ module Phoebe
           #   @return [Symbol, Phoebe::Models::Ref::Region::InfoRetrieveParams::RegionNameFormat, nil]
           optional :region_name_format, enum: -> { Phoebe::Ref::Region::InfoRetrieveParams::RegionNameFormat }
 
-          # @!method initialize(delim: nil, region_name_format: nil, request_options: {})
+          # @!method initialize(region_code:, delim: nil, region_name_format: nil, request_options: {})
+          #   @param region_code [String]
+          #
           #   @param delim [String] The characters used to separate elements in the name.
           #
           #   @param region_name_format [Symbol, Phoebe::Models::Ref::Region::InfoRetrieveParams::RegionNameFormat] Control how the name is displayed.

data/lib/phoebe/models/ref/region/list_list_params.rb

@@ -14,15 +14,22 @@ module Phoebe
           #   @return [String]
           required :region_type, String
 
+          # @!attribute parent_region_code
+          #
+          #   @return [String]
+          required :parent_region_code, String
+
           # @!attribute fmt
           #   Fetch the records in CSV or JSON format.
           #
           #   @return [Symbol, Phoebe::Models::Ref::Region::ListListParams::Fmt, nil]
           optional :fmt, enum: -> { Phoebe::Ref::Region::ListListParams::Fmt }
 
-          # @!method initialize(region_type:, fmt: nil, request_options: {})
+          # @!method initialize(region_type:, parent_region_code:, fmt: nil, request_options: {})
           #   @param region_type [String]
           #
+          #   @param parent_region_code [String]
+          #
           #   @param fmt [Symbol, Phoebe::Models::Ref::Region::ListListParams::Fmt] Fetch the records in CSV or JSON format.
           #
           #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]

data/lib/phoebe/models/ref/taxonomy/form_list_params.rb

@@ -9,7 +9,13 @@ module Phoebe
           extend Phoebe::Internal::Type::RequestParameters::Converter
           include Phoebe::Internal::Type::RequestParameters
 
-          # @!method initialize(request_options: {})
+          # @!attribute species_code
+          #
+          #   @return [String]
+          required :species_code, String
+
+          # @!method initialize(species_code:, request_options: {})
+          #   @param species_code [String]
           #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
         end
       end

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

@@ -9,6 +9,12 @@ module Phoebe
           extend Phoebe::Internal::Type::RequestParameters::Converter
           include Phoebe::Internal::Type::RequestParameters
 
+          # @!attribute species_grouping
+          #   The order in which groups are returned.
+          #
+          #   @return [Symbol, Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping]
+          required :species_grouping, enum: -> { Phoebe::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping }
+
           # @!attribute group_name_locale
           #   Locale for species group names. English names are returned for any non-listed
           #   locale or any non-translated group name.
@@ -16,10 +22,12 @@ module Phoebe
           #   @return [String, nil]
           optional :group_name_locale, String
 
-          # @!method initialize(group_name_locale: nil, request_options: {})
+          # @!method initialize(species_grouping:, group_name_locale: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams} for more details.
           #
+          #   @param species_grouping [Symbol, Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams::SpeciesGrouping] The order in which groups are returned.
+          #
           #   @param group_name_locale [String] Locale for species group names. English names are returned for any non-listed lo
           #
           #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]

data/lib/phoebe/resources/data/observations/geo/recent/notable.rb

@@ -6,6 +6,11 @@ module Phoebe
       class Observations
         class Geo
           class Recent
+            # The data/obs end-points are used to fetch observations submitted to eBird in
+            # checklists. There are two categories of end-point: 1. Fetch observations for a
+            # specific country, region or location. 2. Fetch observations for nearby
+            # locations - up to a distance of 50km. Each end-point supports optional query
+            # parameters which allow you to filter the list of observations returned.
             class Notable
               # Get the list of notable observations (up to 30 days ago) of birds seen at
               # locations within a radius of up to 50 kilometers, from a given set of
@@ -38,10 +43,11 @@ module Phoebe
               # @see Phoebe::Models::Data::Observations::Geo::Recent::NotableListParams
               def list(params)
                 parsed, options = Phoebe::Data::Observations::Geo::Recent::NotableListParams.dump_request(params)
+                query = Phoebe::Internal::Util.encode_query_params(parsed)
                 @client.request(
                   method: :get,
                   path: "data/obs/geo/recent/notable",
-                  query: parsed.transform_keys(max_results: "maxResults", spp_locale: "sppLocale"),
+                  query: query.transform_keys(max_results: "maxResults", spp_locale: "sppLocale"),
                   model: Phoebe::Internal::Type::ArrayOf[Phoebe::Data::Observation],
                   options: options
                 )

data/lib/phoebe/resources/data/observations/geo/recent/species.rb

@@ -6,6 +6,11 @@ module Phoebe
       class Observations
         class Geo
           class Recent
+            # The data/obs end-points are used to fetch observations submitted to eBird in
+            # checklists. There are two categories of end-point: 1. Fetch observations for a
+            # specific country, region or location. 2. Fetch observations for nearby
+            # locations - up to a distance of 50km. Each end-point supports optional query
+            # parameters which allow you to filter the list of observations returned.
             class Species
               # Get all observations of a species, seen up to 30 days ago, at any location
               # within a radius of up to 50 kilometers, from a given set of coordinates. Results
@@ -50,10 +55,11 @@ module Phoebe
               # @see Phoebe::Models::Data::Observations::Geo::Recent::SpecieListParams
               def list(species_code, params)
                 parsed, options = Phoebe::Data::Observations::Geo::Recent::SpecieListParams.dump_request(params)
+                query = Phoebe::Internal::Util.encode_query_params(parsed)
                 @client.request(
                   method: :get,
                   path: ["data/obs/geo/recent/%1$s", species_code],
-                  query: parsed.transform_keys(
+                  query: query.transform_keys(
                     include_provisional: "includeProvisional",
                     max_results: "maxResults",
                     spp_locale: "sppLocale"

data/lib/phoebe/resources/data/observations/geo/recent.rb

@@ -5,10 +5,25 @@ module Phoebe
     class Data
       class Observations
         class Geo
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           class Recent
+            # The data/obs end-points are used to fetch observations submitted to eBird in
+            # checklists. There are two categories of end-point: 1. Fetch observations for a
+            # specific country, region or location. 2. Fetch observations for nearby
+            # locations - up to a distance of 50km. Each end-point supports optional query
+            # parameters which allow you to filter the list of observations returned.
             # @return [Phoebe::Resources::Data::Observations::Geo::Recent::Species]
             attr_reader :species
 
+            # The data/obs end-points are used to fetch observations submitted to eBird in
+            # checklists. There are two categories of end-point: 1. Fetch observations for a
+            # specific country, region or location. 2. Fetch observations for nearby
+            # locations - up to a distance of 50km. Each end-point supports optional query
+            # parameters which allow you to filter the list of observations returned.
             # @return [Phoebe::Resources::Data::Observations::Geo::Recent::Notable]
             attr_reader :notable
 
@@ -46,10 +61,11 @@ module Phoebe
             # @see Phoebe::Models::Data::Observations::Geo::RecentListParams
             def list(params)
               parsed, options = Phoebe::Data::Observations::Geo::RecentListParams.dump_request(params)
+              query = Phoebe::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: "data/obs/geo/recent",
-                query: parsed.transform_keys(
+                query: query.transform_keys(
                   include_provisional: "includeProvisional",
                   max_results: "maxResults",
                   spp_locale: "sppLocale"

data/lib/phoebe/resources/data/observations/geo.rb

@@ -5,6 +5,11 @@ module Phoebe
     class Data
       class Observations
         class Geo
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           # @return [Phoebe::Resources::Data::Observations::Geo::Recent]
           attr_reader :recent
 

data/lib/phoebe/resources/data/observations/nearest/geo_species.rb

@@ -5,6 +5,11 @@ module Phoebe
     class Data
       class Observations
         class Nearest
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           class GeoSpecies
             # Find the nearest locations where a species has been seen recently. #### Notes
             # The species code is typically a 6-letter code, e.g. barswa for Barn Swallow. You
@@ -37,10 +42,11 @@ module Phoebe
             # @see Phoebe::Models::Data::Observations::Nearest::GeoSpecieListParams
             def list(species_code, params)
               parsed, options = Phoebe::Data::Observations::Nearest::GeoSpecieListParams.dump_request(params)
+              query = Phoebe::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: ["data/nearest/geo/recent/%1$s", species_code],
-                query: parsed.transform_keys(
+                query: query.transform_keys(
                   include_provisional: "includeProvisional",
                   max_results: "maxResults",
                   spp_locale: "sppLocale"

data/lib/phoebe/resources/data/observations/nearest.rb

@@ -5,6 +5,11 @@ module Phoebe
     class Data
       class Observations
         class Nearest
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           # @return [Phoebe::Resources::Data::Observations::Nearest::GeoSpecies]
           attr_reader :geo_species
 

data/lib/phoebe/resources/data/observations/recent/historic.rb

@@ -5,6 +5,11 @@ module Phoebe
     class Data
       class Observations
         class Recent
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           class Historic
             # Get a list of all taxa seen in a country, region or location on a specific date,
             # with the specific observations determined by the "rank" parameter (defaults to
@@ -14,13 +19,13 @@ module Phoebe
             #
             # @overload list(d, region_code:, y_:, m:, cat: nil, detail: nil, hotspot: nil, include_provisional: nil, max_results: nil, r: nil, rank: nil, spp_locale: nil, request_options: {})
             #
-            # @param d [Integer] Path param:
+            # @param d [Integer] Path param
             #
             # @param region_code [String] Path param: The country, subnational1, subnational2 or location code.
             #
-            # @param y_ [Integer] Path param:
+            # @param y_ [Integer] Path param
             #
-            # @param m [Integer] Path param:
+            # @param m [Integer] Path param
             #
             # @param cat [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Cat] Query param: Only fetch observations from these taxonomic categories
             #
@@ -45,6 +50,7 @@ module Phoebe
             # @see Phoebe::Models::Data::Observations::Recent::HistoricListParams
             def list(d, params)
               parsed, options = Phoebe::Data::Observations::Recent::HistoricListParams.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}")
@@ -60,7 +66,7 @@ module Phoebe
               @client.request(
                 method: :get,
                 path: ["data/obs/%1$s/historic/%2$s/%3$s/%4$s", region_code, y_, m, d],
-                query: parsed.transform_keys(
+                query: query.transform_keys(
                   include_provisional: "includeProvisional",
                   max_results: "maxResults",
                   spp_locale: "sppLocale"

data/lib/phoebe/resources/data/observations/recent/notable.rb

@@ -5,6 +5,11 @@ module Phoebe
     class Data
       class Observations
         class Recent
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           class Notable
             # Get the list of recent, notable observations (up to 30 days ago) of birds seen
             # in a country, region or location. Notable observations can be for locally or
@@ -34,10 +39,11 @@ module Phoebe
             # @see Phoebe::Models::Data::Observations::Recent::NotableListParams
             def list(region_code, params = {})
               parsed, options = Phoebe::Data::Observations::Recent::NotableListParams.dump_request(params)
+              query = Phoebe::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: ["data/obs/%1$s/recent/notable", region_code],
-                query: parsed.transform_keys(max_results: "maxResults", spp_locale: "sppLocale"),
+                query: query.transform_keys(max_results: "maxResults", spp_locale: "sppLocale"),
                 model: Phoebe::Internal::Type::ArrayOf[Phoebe::Data::Observation],
                 options: options
               )

data/lib/phoebe/resources/data/observations/recent/species.rb

@@ -5,6 +5,11 @@ module Phoebe
     class Data
       class Observations
         class Recent
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           class Species
             # Get the recent observations, up to 30 days ago, of a particular species in a
             # country, region or location. Results include only the most recent observation
@@ -43,6 +48,7 @@ module Phoebe
             # @see Phoebe::Models::Data::Observations::Recent::SpecieRetrieveParams
             def retrieve(species_code, params)
               parsed, options = Phoebe::Data::Observations::Recent::SpecieRetrieveParams.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}")
@@ -50,7 +56,7 @@ module Phoebe
               @client.request(
                 method: :get,
                 path: ["data/obs/%1$s/recent/%2$s", region_code, species_code],
-                query: parsed.transform_keys(
+                query: query.transform_keys(
                   include_provisional: "includeProvisional",
                   max_results: "maxResults",
                   spp_locale: "sppLocale"

data/lib/phoebe/resources/data/observations/recent.rb

@@ -4,13 +4,33 @@ module Phoebe
   module Resources
     class Data
       class Observations
+        # The data/obs end-points are used to fetch observations submitted to eBird in
+        # checklists. There are two categories of end-point: 1. Fetch observations for a
+        # specific country, region or location. 2. Fetch observations for nearby
+        # locations - up to a distance of 50km. Each end-point supports optional query
+        # parameters which allow you to filter the list of observations returned.
         class Recent
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           # @return [Phoebe::Resources::Data::Observations::Recent::Notable]
           attr_reader :notable
 
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           # @return [Phoebe::Resources::Data::Observations::Recent::Species]
           attr_reader :species
 
+          # The data/obs end-points are used to fetch observations submitted to eBird in
+          # checklists. There are two categories of end-point: 1. Fetch observations for a
+          # specific country, region or location. 2. Fetch observations for nearby
+          # locations - up to a distance of 50km. Each end-point supports optional query
+          # parameters which allow you to filter the list of observations returned.
           # @return [Phoebe::Resources::Data::Observations::Recent::Historic]
           attr_reader :historic
 
@@ -43,10 +63,11 @@ module Phoebe
           # @see Phoebe::Models::Data::Observations::RecentListParams
           def list(region_code, params = {})
             parsed, options = Phoebe::Data::Observations::RecentListParams.dump_request(params)
+            query = Phoebe::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["data/obs/%1$s/recent", region_code],
-              query: parsed.transform_keys(
+              query: query.transform_keys(
                 include_provisional: "includeProvisional",
                 max_results: "maxResults",
                 spp_locale: "sppLocale"

data/lib/phoebe/resources/data/observations.rb

@@ -4,6 +4,11 @@ module Phoebe
   module Resources
     class Data
       class Observations
+        # The data/obs end-points are used to fetch observations submitted to eBird in
+        # checklists. There are two categories of end-point: 1. Fetch observations for a
+        # specific country, region or location. 2. Fetch observations for nearby
+        # locations - up to a distance of 50km. Each end-point supports optional query
+        # parameters which allow you to filter the list of observations returned.
         # @return [Phoebe::Resources::Data::Observations::Recent]
         attr_reader :recent
 

data/lib/phoebe/resources/product/checklist.rb

@@ -3,6 +3,11 @@
 module Phoebe
   module Resources
     class Product
+      # 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.
       class Checklist
         # Get the details and observations of a checklist.
         #

data/lib/phoebe/resources/product/lists/historical.rb

@@ -4,6 +4,11 @@ module Phoebe
   module Resources
     class Product
       class Lists
+        # 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.
         class Historical
           # Some parameter documentations has been truncated, see
           # {Phoebe::Models::Product::Lists::HistoricalRetrieveParams} for more details.
@@ -32,6 +37,7 @@ module Phoebe
           # @see Phoebe::Models::Product::Lists::HistoricalRetrieveParams
           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}")
@@ -47,7 +53,7 @@ module Phoebe
             @client.request(
               method: :get,
               path: ["product/lists/%1$s/%2$s/%3$s/%4$s", region_code, y_, m, d],
-              query: parsed.transform_keys(max_results: "maxResults", sort_key: "sortKey"),
+              query: query.transform_keys(max_results: "maxResults", sort_key: "sortKey"),
               model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem],
               options: options
             )

data/lib/phoebe/resources/product/lists.rb

@@ -3,7 +3,17 @@
 module Phoebe
   module Resources
     class Product
+      # The data/obs end-points are used to fetch observations submitted to eBird in
+      # checklists. There are two categories of end-point: 1. Fetch observations for a
+      # specific country, region or location. 2. Fetch observations for nearby
+      # locations - up to a distance of 50km. Each end-point supports optional query
+      # parameters which allow you to filter the list of observations returned.
       class Lists
+        # 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.
         # @return [Phoebe::Resources::Product::Lists::Historical]
         attr_reader :historical
 
@@ -22,10 +32,11 @@ module Phoebe
         # @see Phoebe::Models::Product::ListRetrieveParams
         def retrieve(region_code, params = {})
           parsed, options = Phoebe::Product::ListRetrieveParams.dump_request(params)
+          query = Phoebe::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["product/lists/%1$s", region_code],
-            query: parsed.transform_keys(max_results: "maxResults"),
+            query: query.transform_keys(max_results: "maxResults"),
             model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Product::ListRetrieveResponseItem],
             options: options
           )

data/lib/phoebe/resources/product/species_list.rb

@@ -3,6 +3,11 @@
 module Phoebe
   module Resources
     class Product
+      # 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.
       class SpeciesList
         # Some parameter documentations has been truncated, see
         # {Phoebe::Models::Product::SpeciesListListParams} for more details.

data/lib/phoebe/resources/product/stats.rb

@@ -3,6 +3,11 @@
 module Phoebe
   module Resources
     class Product
+      # 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.
       class Stats
         # Get a summary of the number of checklist submitted, species seen and
         # contributors on a given date for a country or region.

data/lib/phoebe/resources/product/top100.rb

@@ -3,6 +3,11 @@
 module Phoebe
   module Resources
     class Product
+      # 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.
       class Top100
         # Some parameter documentations has been truncated, see
         # {Phoebe::Models::Product::Top100RetrieveParams} for more details.
@@ -46,6 +51,7 @@ module Phoebe
         # @see Phoebe::Models::Product::Top100RetrieveParams
         def retrieve(d, params)
           parsed, options = Phoebe::Product::Top100RetrieveParams.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}")
@@ -61,7 +67,7 @@ module Phoebe
           @client.request(
             method: :get,
             path: ["product/top100/%1$s/%2$s/%3$s/%4$s", region_code, y_, m, d],
-            query: parsed.transform_keys(max_results: "maxResults", ranked_by: "rankedBy"),
+            query: query.transform_keys(max_results: "maxResults", ranked_by: "rankedBy"),
             model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Product::Top100RetrieveResponseItem],
             options: options
           )

data/lib/phoebe/resources/product.rb

@@ -3,18 +3,43 @@
 module Phoebe
   module Resources
     class Product
+      # The data/obs end-points are used to fetch observations submitted to eBird in
+      # checklists. There are two categories of end-point: 1. Fetch observations for a
+      # specific country, region or location. 2. Fetch observations for nearby
+      # locations - up to a distance of 50km. Each end-point supports optional query
+      # parameters which allow you to filter the list of observations returned.
       # @return [Phoebe::Resources::Product::Lists]
       attr_reader :lists
 
+      # 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.
       # @return [Phoebe::Resources::Product::Top100]
       attr_reader :top100
 
+      # 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.
       # @return [Phoebe::Resources::Product::Stats]
       attr_reader :stats
 
+      # 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.
       # @return [Phoebe::Resources::Product::SpeciesList]
       attr_reader :species_list
 
+      # 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.
       # @return [Phoebe::Resources::Product::Checklist]
       attr_reader :checklist