-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Client functions for querying the eBird API. -- -- eBird is a massive collection of ornithological science -- projects developed by the Cornell Lab of Ornithology. The -- eBird API offers programmatic access to the incredible dataset -- backing these projects. -- -- This library contains functions for retrieving data from the eBird -- API, as defined in the ebird-api library. -- -- If you'd like to run the queries defined in this library directly on -- your command line, checkout out the ebird-cli. @package ebird-client @version 0.2.0.0 -- | Client functions generated using servant-client. The queries -- here match exactly the schemas defined in ebird-api, and are -- therefore potentially a bit more clunky to use. See the wrappers in -- Client for more convenient options. module Data.EBird.Client.Generated -- | Get a list of recent observations within a region. Results only -- include the most recent observation for each species in the region. -- -- See the eBird API documentation for the corresponding endpoint. recentObservations_ :: Text -> RegionCode -> Maybe Integer -> Maybe TaxonomyCategories -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe RegionCode -> Maybe SPPLocale -> ClientM [Observation 'Simple] -- | Get a list of recent notable observations within a region. Results -- only include the most recent observation for each species in the -- region. -- -- See the eBird API documentation for the corresponding endpoint. recentNotableObservations_ :: Text -> RegionCode -> Maybe Integer -> Maybe DetailLevel -> Maybe Bool -> Maybe Integer -> Maybe RegionCode -> Maybe SPPLocale -> ClientM [SomeObservation] -- | Get a list of recent observations of a specific species within a -- region. -- -- See the eBird API documentation for the corresponding endpoint. recentSpeciesObservations_ :: Text -> RegionCode -> SpeciesCode -> Maybe Integer -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe RegionCode -> Maybe SPPLocale -> ClientM [Observation 'Simple] -- | Get a list of recent observations within some radius of some -- latitude/longitude. -- -- See the eBird API documentation for the corresponding endpoint. recentNearbyObservations_ :: Text -> Double -> Double -> Maybe Integer -> Maybe Integer -> Maybe TaxonomyCategories -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SortObservationsBy -> Maybe SPPLocale -> ClientM [Observation 'Simple] -- | Get a list of recent observations of a species within some radius of -- some latitude/longitude. -- -- See the eBird API documentation for the corresponding endpoint. recentNearbySpeciesObservations_ :: Text -> SpeciesCode -> Double -> Double -> Maybe Integer -> Maybe Integer -> Maybe TaxonomyCategories -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SortObservationsBy -> Maybe SPPLocale -> ClientM [Observation 'Simple] -- | Get a list of recent observations of some species nearest to some -- latitude/longitude. -- -- See the eBird API documentation for the corresponding endpoint. recentNearestSpeciesObservations_ :: Text -> SpeciesCode -> Double -> Double -> Maybe Integer -> Maybe Integer -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SPPLocale -> ClientM [Observation 'Simple] -- | Get a list of recent notable observations of some near some -- latitude/longitude. -- -- See the eBird API documentation for the corresponding endpoint. recentNearbyNotableObservations_ :: Text -> Double -> Double -> Maybe Integer -> Maybe DetailLevel -> Maybe Integer -> Maybe Bool -> Maybe Integer -> Maybe SPPLocale -> ClientM [SomeObservation] -- | Get a list of observations for each species seen on a specific date. -- The specific observations returned are determined by the -- SelectObservation parameter - first observation of the species -- (SelectFirstObservation) or last observation -- (SelectLastObservation, default). -- -- See the eBird API documentation for the corresponding endpoint. historicalObservations_ :: Text -> RegionCode -> Integer -> Integer -> Integer -> Maybe TaxonomyCategories -> Maybe DetailLevel -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SelectObservation -> Maybe RegionCode -> Maybe SPPLocale -> ClientM [SomeObservation] -- | Get a list recently submitted checklists within a region. -- -- See the eBird API documentation for the corresponding endpoint. recentChecklists_ :: Text -> RegionCode -> Maybe Integer -> ClientM [ChecklistFeedEntry] -- | Get a list of top contributors for a region on a specific date, ranked -- by number of species observed or number of checklists submitted. -- -- See the eBird API documentation for the corresponding endpoint. top100_ :: Text -> Region -> Integer -> Integer -> Integer -> Maybe RankTop100By -> Maybe Integer -> ClientM [Top100ListEntry] -- | Get a list of checklists submitted within a region on a specific date. -- -- See the eBird API documentation for the corresponding endpoint. checklistFeed_ :: Text -> Region -> Integer -> Integer -> Integer -> Maybe SortChecklistsBy -> Maybe Integer -> ClientM [ChecklistFeedEntry] -- | Get the RegionalStatistics for a region on a specific date. -- -- See the eBird API documentation for the corresponding endpoint. regionalStatistics_ :: Text -> Region -> Integer -> Integer -> Integer -> ClientM RegionalStatistics -- | Get a list of all species ever seen in a region. -- -- See the eBird API documentation for the corresponding endpoint. speciesList_ :: Text -> Region -> ClientM [SpeciesCode] -- | Get information about a checklist. -- -- See the eBird API documentation for the corresponding endpoint. viewChecklist_ :: Text -> Text -> ClientM Checklist -- | Get all hotspots in a list of one or more regions (RegionCode). -- -- See the eBird API documentation for the corresponding endpoint. -- -- NOTE: The eBird API is broken. Always hardcode the -- CSVOrJSONFormat argument to JSONFormat. regionHotspots_ :: RegionCode -> Maybe Integer -> Maybe CSVOrJSONFormat -> ClientM [Hotspot] -- | Get all hotspots within a radius of some latitude/longitude. -- -- See the eBird API documentation for the corresponding endpoint. -- -- NOTE: The eBird API is broken. Always hardcode the -- CSVOrJSONFormat argument to JSONFormat. nearbyHotspots_ :: Double -> Double -> Maybe Integer -> Maybe Integer -> Maybe CSVOrJSONFormat -> ClientM [Hotspot] -- | Get information about a hotspot. -- -- See the eBird API documentation for the corresponding endpoint. hotspotInfo_ :: Text -> ClientM LocationData -- | Get any version of the eBird taxonomy, with optional filtering based -- on taxonomy categories and species. -- -- See the eBird API documentation for the corresponding endpoint. -- -- NOTE: The eBird API is broken. Always hardcode the -- CSVOrJSONFormat argument to JSONFormat. taxonomy_ :: Maybe TaxonomyCategories -> Maybe CSVOrJSONFormat -> Maybe SPPLocale -> Maybe SpeciesCodes -> Maybe Text -> ClientM [Taxon] -- | Get the list of sub species of a given species recognized in the eBird -- taxonomy. -- -- See the eBird API documentation for the corresponding endpoint. taxonomicForms_ :: Text -> SpeciesCode -> ClientM SpeciesCodes -- | Get the supported locale codes and names for species common names, -- with the last time they were updated. -- -- See the eBird API documentation for the corresponding endpoint. taxaLocaleCodes_ :: Text -> Maybe SPPLocale -> ClientM [SPPLocaleListEntry] -- | Get all versions of the taxonomy, with a flag indicating which is -- latest. -- -- See the eBird API documentation for the corresponding endpoint. taxonomyVersions_ :: ClientM [TaxonomyVersionListEntry] -- | Get the list of species groups, in either Merlin or eBird grouping. -- -- See the eBird API documentation for the corresponding endpoint. taxonomicGroups_ :: SPPGrouping -> Maybe SPPLocale -> ClientM [TaxonomicGroupListEntry] -- | Get a RegionInfo for an eBird region. -- -- See the eBird API documentation for the corresponding endpoint. regionInfo_ :: Text -> Region -> Maybe RegionNameFormat -> ClientM RegionInfo -- | Get a list of subregions of a given region type within a given region. -- Keep in mind that many combinations of sub region and parent region -- are invalid, e.g. CountryType regions within "US-WY". -- -- See the eBird API documentation for the corresponding endpoint. subregionList_ :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry] -- | Get a list of regions adjacent to a given region. Only -- Subnational2 region codes in the United States, New Zealand, or -- Mexico are currently supported. -- -- See the eBird API documentation for the corresponding endpoint. adjacentRegions_ :: Text -> Region -> ClientM [RegionListEntry] -- | Types and functions for hotspot-related eBird API queries. module Data.EBird.Client.Hotspots -- | Get all hotspots in a list of one or more regions (RegionCode). -- -- For example, get the hotspots in Albany County, Wyoming and Park -- County, Wyoming that have been visited in the last 5 days (using -- -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $ regionHotspots "US-WY-001,US-WY-029" (def & #back ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. regionHotspots :: RegionCode -> RegionHotspotsParams -> ClientM [Hotspot] -- | Optional parameters accepted by the RegionHotspotsAPI. -- -- Note that defaultRegionHotspotsParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _regionHotspotsParamsBack field to 10: -- -- 
--   def & regionHotspotsParamsBack ?~ 10
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #back ?~ 10
--
newtype RegionHotspotsParams RegionHotspotsParams :: Maybe Integer -> RegionHotspotsParams -- | Only fetch hotspots that have been visited within this many days ago -- -- 1 - 30, default: no limit [_regionHotspotsParamsBack] :: RegionHotspotsParams -> Maybe Integer -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRegionHotspotsParams :: RegionHotspotsParams regionHotspotsParamsBack :: Iso' RegionHotspotsParams (Maybe Integer) -- | Get all hotspots within a radius of some latitude/longitude. -- -- For example, get the hotspots within 30km of Cody, Wyoming that have -- been visited in the last 5 days (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     nearbyHotspots
--       44.526340 (-109.056534)
--       (def & #radius ?~ 30 & #back ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. nearbyHotspots :: Double -> Double -> NearbyHotspotsParams -> ClientM [Hotspot] -- | Optional parameters accepted by the NearbyHotspotsAPI. -- -- Note that defaultNearbyHotspotsParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _nearbyHotspotsParamsBack field to 10: -- -- 
--   def & nearbyHotspotsParamsBack ?~ 10
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #back ?~ 10
--
data NearbyHotspotsParams NearbyHotspotsParams :: Maybe Integer -> Maybe Integer -> NearbyHotspotsParams -- | Only fetch hotspots that have been visited within this many days ago -- -- 1 - 30, default: no limit [_nearbyHotspotsParamsBack] :: NearbyHotspotsParams -> Maybe Integer [_nearbyHotspotsParamsRadius] :: NearbyHotspotsParams -> Maybe Integer -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultNearbyHotspotsParams :: NearbyHotspotsParams nearbyHotspotsParamsRadius :: Lens' NearbyHotspotsParams (Maybe Integer) nearbyHotspotsParamsBack :: Lens' NearbyHotspotsParams (Maybe Integer) -- | Get information about a hotspot. -- -- For example, get information for a hotspot with location ID "L2373040" -- (using -XOverloadedStrings): -- -- 
--   askEBird $ hotspotInfo L2373040
--
-- -- Note that the endpoint for this query is simple enough that -- hotspotInfo is equivalent to the generated hotspotInfo_. -- -- See the eBird API documentation for the corresponding endpoint. hotspotInfo :: Text -> ClientM LocationData instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Hotspots.NearbyHotspotsParams Data.EBird.Client.Hotspots.NearbyHotspotsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "radius" k Data.EBird.Client.Hotspots.NearbyHotspotsParams Data.EBird.Client.Hotspots.NearbyHotspotsParams a b instance GHC.Classes.Eq Data.EBird.Client.Hotspots.NearbyHotspotsParams instance GHC.Read.Read Data.EBird.Client.Hotspots.NearbyHotspotsParams instance GHC.Show.Show Data.EBird.Client.Hotspots.NearbyHotspotsParams instance Data.Default.Class.Default Data.EBird.Client.Hotspots.NearbyHotspotsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.An_Iso, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Hotspots.RegionHotspotsParams Data.EBird.Client.Hotspots.RegionHotspotsParams a b instance GHC.Classes.Eq Data.EBird.Client.Hotspots.RegionHotspotsParams instance GHC.Read.Read Data.EBird.Client.Hotspots.RegionHotspotsParams instance GHC.Show.Show Data.EBird.Client.Hotspots.RegionHotspotsParams instance Data.Default.Class.Default Data.EBird.Client.Hotspots.RegionHotspotsParams -- | Types and functions for observation-related eBird API queries. module Data.EBird.Client.Observations -- | Get a list of recent observations within a region. Results only -- include the most recent observation for each species in the region. -- -- For example, get up to 10 recent observations from the last 5 days in -- Park County, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentObservations key
--       "US-WY-029"
--       (def & #maxResults ?~ 10 & #back ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentObservations :: Text -> RegionCode -> RecentObservationsParams -> ClientM [Observation 'Simple] -- | Optional parameters accepted by the RecentObservationsAPI. -- -- Note that defaultRecentObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentObservationsParamsBack field to 30: -- -- 
--   def & recentObservationsParamsBack ?~ 30
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #back ?~ 30
--
data RecentObservationsParams RecentObservationsParams :: Maybe Integer -> Maybe TaxonomyCategories -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe RegionCode -> Maybe SPPLocale -> RecentObservationsParams -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentObservationsParamsBack] :: RecentObservationsParams -> Maybe Integer -- | Only include observations in these taxonomy categories -- -- default: all categories [_recentObservationsParamsCategories] :: RecentObservationsParams -> Maybe TaxonomyCategories -- | Only get observations from hotspots -- -- default: False [_recentObservationsParamsHotspot] :: RecentObservationsParams -> Maybe Bool -- | Include observations which have not been reviewed -- -- default: False [_recentObservationsParamsProvisional] :: RecentObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentObservationsParamsMaxResults] :: RecentObservationsParams -> Maybe Integer -- | Up to 10 extra regions to get observations from -- -- default: none [_recentObservationsParamsExtraRegions] :: RecentObservationsParams -> Maybe RegionCode -- | Return observations with common names in this locale -- -- default: En [_recentObservationsParamsLocale] :: RecentObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentObservationsParams :: RecentObservationsParams recentObservationsParamsProvisional :: Lens' RecentObservationsParams (Maybe Bool) recentObservationsParamsMaxResults :: Lens' RecentObservationsParams (Maybe Integer) recentObservationsParamsLocale :: Lens' RecentObservationsParams (Maybe SPPLocale) recentObservationsParamsHotspot :: Lens' RecentObservationsParams (Maybe Bool) recentObservationsParamsExtraRegions :: Lens' RecentObservationsParams (Maybe RegionCode) recentObservationsParamsCategories :: Lens' RecentObservationsParams (Maybe TaxonomyCategories) recentObservationsParamsBack :: Lens' RecentObservationsParams (Maybe Integer) -- | Get a list of recent notable observations within a region. Results -- only include the most recent observation for each species in the -- region. -- -- For example, get up to 10 recent notable observations from the last 30 -- days in Park County, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNotableObservations key
--       "US-WY-029"
--       (def & #maxResults ?~ 10 & #back ?~ 30)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNotableObservations :: Text -> RegionCode -> RecentNotableObservationsParams -> ClientM [SomeObservation] -- | Optional parameters accepted by the -- RecentNotableObservationsAPI. -- -- Note that defaultRecentNotableObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentNotableObservationsParamsBack field to 30: -- -- 
--   def & recentNotableObservationsParamsBack ?~ 30
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #back ?~ 30
--
data RecentNotableObservationsParams RecentNotableObservationsParams :: Maybe Integer -> Maybe DetailLevel -> Maybe Bool -> Maybe Integer -> Maybe RegionCode -> Maybe SPPLocale -> RecentNotableObservationsParams -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentNotableObservationsParamsBack] :: RecentNotableObservationsParams -> Maybe Integer -- | Detail level for the resulting observations -- -- default: Simple [_recentNotableObservationsParamsDetail] :: RecentNotableObservationsParams -> Maybe DetailLevel -- | Only get observations from hotspots -- -- default: False [_recentNotableObservationsParamsHotspot] :: RecentNotableObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentNotableObservationsParamsMaxResults] :: RecentNotableObservationsParams -> Maybe Integer -- | Up to 10 extra regions to get observations from -- -- default: none [_recentNotableObservationsParamsExtraRegions] :: RecentNotableObservationsParams -> Maybe RegionCode -- | Return observations with common names in this locale -- -- default: En [_recentNotableObservationsParamsLocale] :: RecentNotableObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentNotableObservationsParams :: RecentNotableObservationsParams recentNotableObservationsParamsMaxResults :: Lens' RecentNotableObservationsParams (Maybe Integer) recentNotableObservationsParamsLocale :: Lens' RecentNotableObservationsParams (Maybe SPPLocale) recentNotableObservationsParamsHotspot :: Lens' RecentNotableObservationsParams (Maybe Bool) recentNotableObservationsParamsExtraRegions :: Lens' RecentNotableObservationsParams (Maybe RegionCode) recentNotableObservationsParamsDetail :: Lens' RecentNotableObservationsParams (Maybe DetailLevel) recentNotableObservationsParamsBack :: Lens' RecentNotableObservationsParams (Maybe Integer) -- | Get a list of recent observations of a specific species within a -- region. -- -- For example, get observations of Peregrine Falcons from the last 30 -- days in Park County, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentSpeciesObservations key
--       "US-WY-029"
--       "perfal"
--       (def & #back ?~ 30)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentSpeciesObservations :: Text -> RegionCode -> SpeciesCode -> RecentSpeciesObservationsParams -> ClientM [Observation 'Simple] -- | Optional parameters accepted by the -- RecentSpeciesObservationsAPI. -- -- Note that defaultRecentSpeciesObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentSpeciesObservationsParamsBack field to 30: -- -- 
--   def & recentSpeciesObservationsParamsBack ?~ 30
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #back ?~ 30
--
data RecentSpeciesObservationsParams RecentSpeciesObservationsParams :: Maybe Integer -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe RegionCode -> Maybe SPPLocale -> RecentSpeciesObservationsParams -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentSpeciesObservationsParamsBack] :: RecentSpeciesObservationsParams -> Maybe Integer -- | Only get observations from hotspots -- -- default: False [_recentSpeciesObservationsParamsHotspot] :: RecentSpeciesObservationsParams -> Maybe Bool -- | Include observations which have not been reviewed -- -- default: False [_recentSpeciesObservationsParamsProvisional] :: RecentSpeciesObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentSpeciesObservationsParamsMaxResults] :: RecentSpeciesObservationsParams -> Maybe Integer -- | Up to 10 extra regions to get observations from -- -- default: none [_recentSpeciesObservationsParamsExtraRegions] :: RecentSpeciesObservationsParams -> Maybe RegionCode -- | Return observations with common names in this locale -- -- default: En [_recentSpeciesObservationsParamsLocale] :: RecentSpeciesObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentSpeciesObservationsParams :: RecentSpeciesObservationsParams recentSpeciesObservationsParamsProvisional :: Lens' RecentSpeciesObservationsParams (Maybe Bool) recentSpeciesObservationsParamsMaxResults :: Lens' RecentSpeciesObservationsParams (Maybe Integer) recentSpeciesObservationsParamsLocale :: Lens' RecentSpeciesObservationsParams (Maybe SPPLocale) recentSpeciesObservationsParamsHotspot :: Lens' RecentSpeciesObservationsParams (Maybe Bool) recentSpeciesObservationsParamsExtraRegions :: Lens' RecentSpeciesObservationsParams (Maybe RegionCode) recentSpeciesObservationsParamsBack :: Lens' RecentSpeciesObservationsParams (Maybe Integer) -- | Get a list of recent observations within some radius of some -- latitude/longitude. -- -- For example, get up to 5 nearby observations within 10km of Cody, -- Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearbyObservations key
--       44.526340 (-109.056534)
--       (def & #maxResults ?~ 5 & #radius ?~ 10)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearbyObservations :: Text -> Double -> Double -> RecentNearbyObservationsParams -> ClientM [Observation 'Simple] -- | Optional parameters accepted by the -- RecentNearbyObservationsAPI. -- -- Note that defaultRecentNearbyObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentNearbyObservationsParamsRadius field to 10km: -- -- 
--   def & recentNearbyObservationsParamsRadius ?~ 10
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #radius ?~ 10
--
data RecentNearbyObservationsParams RecentNearbyObservationsParams :: Maybe Integer -> Maybe Integer -> Maybe TaxonomyCategories -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SortObservationsBy -> Maybe SPPLocale -> RecentNearbyObservationsParams -- | Search radius from the given latitude/longitude in kilometers -- -- 0 - 50, default: 25 [_recentNearbyObservationsParamsRadius] :: RecentNearbyObservationsParams -> Maybe Integer -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentNearbyObservationsParamsBack] :: RecentNearbyObservationsParams -> Maybe Integer -- | Only include observations in these taxonomy categories -- -- default: all [_recentNearbyObservationsParamsCategories] :: RecentNearbyObservationsParams -> Maybe TaxonomyCategories -- | Only get observations from hotspots -- -- default: False [_recentNearbyObservationsParamsHotspot] :: RecentNearbyObservationsParams -> Maybe Bool -- | Include observations which have not been reviewed -- -- default: False [_recentNearbyObservationsParamsProvisional] :: RecentNearbyObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentNearbyObservationsParamsMaxResults] :: RecentNearbyObservationsParams -> Maybe Integer -- | Sort observations by taxonomy (SortObservationsBySpecies) or by -- date (SortObservationsByDate, most recent first) -- -- default: SortObservationsByDate [_recentNearbyObservationsParamsSortBy] :: RecentNearbyObservationsParams -> Maybe SortObservationsBy -- | Return observations with common names in this locale -- -- default: En [_recentNearbyObservationsParamsLocale] :: RecentNearbyObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentNearbyObservationsParams :: RecentNearbyObservationsParams recentNearbyObservationsParamsSortBy :: Lens' RecentNearbyObservationsParams (Maybe SortObservationsBy) recentNearbyObservationsParamsRadius :: Lens' RecentNearbyObservationsParams (Maybe Integer) recentNearbyObservationsParamsProvisional :: Lens' RecentNearbyObservationsParams (Maybe Bool) recentNearbyObservationsParamsMaxResults :: Lens' RecentNearbyObservationsParams (Maybe Integer) recentNearbyObservationsParamsLocale :: Lens' RecentNearbyObservationsParams (Maybe SPPLocale) recentNearbyObservationsParamsHotspot :: Lens' RecentNearbyObservationsParams (Maybe Bool) recentNearbyObservationsParamsCategories :: Lens' RecentNearbyObservationsParams (Maybe TaxonomyCategories) recentNearbyObservationsParamsBack :: Lens' RecentNearbyObservationsParams (Maybe Integer) -- | Get a list of recent observations of a species within some radius of -- some latitude/longitude. -- -- For example, get up to 5 nearby observations of Peregrine Falcons -- within 50km of Cody, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearbySpeciesObservations key
--       "perfal"
--       44.526340 (-109.056534)
--       (def & #radius ?~ 50 & #maxResults ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearbySpeciesObservations :: Text -> SpeciesCode -> Double -> Double -> RecentNearbySpeciesObservationsParams -> ClientM [Observation 'Simple] -- | Optional parameters accepted by the -- RecentNearbySpeciesObservationsAPI. -- -- Note that defaultRecentNearbySpeciesObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentNearbySpeciesObservationsParamsRadius field to 10km: -- -- 
--   def & recentNearbySpeciesObservationsParamsRadius ?~ 10
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #radius ?~ 10
--
data RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams :: Maybe Integer -> Maybe Integer -> Maybe TaxonomyCategories -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SortObservationsBy -> Maybe SPPLocale -> RecentNearbySpeciesObservationsParams -- | Search radius from the given latitude/longitude in kilometers -- -- 0 - 50, default: 25 [_recentNearbySpeciesObservationsParamsRadius] :: RecentNearbySpeciesObservationsParams -> Maybe Integer -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentNearbySpeciesObservationsParamsBack] :: RecentNearbySpeciesObservationsParams -> Maybe Integer -- | Only include observations in these taxonomy categories -- -- default: all [_recentNearbySpeciesObservationsParamsCategories] :: RecentNearbySpeciesObservationsParams -> Maybe TaxonomyCategories -- | Only get observations from hotspots -- -- default: False [_recentNearbySpeciesObservationsParamsHotspot] :: RecentNearbySpeciesObservationsParams -> Maybe Bool -- | Include observations which have not been reviewed -- -- default: False [_recentNearbySpeciesObservationsParamsProvisional] :: RecentNearbySpeciesObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentNearbySpeciesObservationsParamsMaxResults] :: RecentNearbySpeciesObservationsParams -> Maybe Integer -- | Sort observations by taxonomy (SortObservationsBySpecies) or by -- date (SortObservationsByDate, most recent first) -- -- default: SortObservationsByDate [_recentNearbySpeciesObservationsParamsSortBy] :: RecentNearbySpeciesObservationsParams -> Maybe SortObservationsBy -- | Return observations with common names in this locale -- -- default: En [_recentNearbySpeciesObservationsParamsLocale] :: RecentNearbySpeciesObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentNearbySpeciesObservationsParams :: RecentNearbySpeciesObservationsParams recentNearbySpeciesObservationsParamsSortBy :: Lens' RecentNearbySpeciesObservationsParams (Maybe SortObservationsBy) recentNearbySpeciesObservationsParamsRadius :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer) recentNearbySpeciesObservationsParamsProvisional :: Lens' RecentNearbySpeciesObservationsParams (Maybe Bool) recentNearbySpeciesObservationsParamsMaxResults :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer) recentNearbySpeciesObservationsParamsLocale :: Lens' RecentNearbySpeciesObservationsParams (Maybe SPPLocale) recentNearbySpeciesObservationsParamsHotspot :: Lens' RecentNearbySpeciesObservationsParams (Maybe Bool) recentNearbySpeciesObservationsParamsCategories :: Lens' RecentNearbySpeciesObservationsParams (Maybe TaxonomyCategories) recentNearbySpeciesObservationsParamsBack :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer) -- | Get a list of recent observations of some species nearest to some -- latitude/longitude. -- -- For example, get the 5 nearest observations of Black-throated Gray -- Warblers within 50km of Capitol Reef National Park (using -- -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearestSpeciesObservations key
--       "btywar"
--       38.366970 (-111.261504)
--       (def & #radius ?~ 50 & #maxResults ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearestSpeciesObservations :: Text -> SpeciesCode -> Double -> Double -> RecentNearestSpeciesObservationsParams -> ClientM [Observation 'Simple] -- | Optional parameters accepted by the -- RecentNearestSpeciesObservationsAPI. -- -- Note that defaultRecentNearestSpeciesObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentNearestSpeciesObservationsParamsRadius field to 10km: -- -- 
--   def & recentNearestSpeciesObservationsParamsRadius ?~ 10
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #radius ?~ 10
--
data RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams :: Maybe Integer -> Maybe Integer -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SPPLocale -> RecentNearestSpeciesObservationsParams -- | Search radius from the given latitude/longitude in kilometers -- -- 0 - 50, default: 25 [_recentNearestSpeciesObservationsParamsRadius] :: RecentNearestSpeciesObservationsParams -> Maybe Integer -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentNearestSpeciesObservationsParamsBack] :: RecentNearestSpeciesObservationsParams -> Maybe Integer -- | Only get observations from hotspots -- -- default: False [_recentNearestSpeciesObservationsParamsHotspot] :: RecentNearestSpeciesObservationsParams -> Maybe Bool -- | Include observations which have not been reviewed -- -- default: False [_recentNearestSpeciesObservationsParamsProvisional] :: RecentNearestSpeciesObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentNearestSpeciesObservationsParamsMaxResults] :: RecentNearestSpeciesObservationsParams -> Maybe Integer -- | Return observations with common names in this locale -- -- default: En [_recentNearestSpeciesObservationsParamsLocale] :: RecentNearestSpeciesObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentNearestSpeciesObservationsParams :: RecentNearestSpeciesObservationsParams recentNearestSpeciesObservationsParamsRadius :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer) recentNearestSpeciesObservationsParamsProvisional :: Lens' RecentNearestSpeciesObservationsParams (Maybe Bool) recentNearestSpeciesObservationsParamsMaxResults :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer) recentNearestSpeciesObservationsParamsLocale :: Lens' RecentNearestSpeciesObservationsParams (Maybe SPPLocale) recentNearestSpeciesObservationsParamsHotspot :: Lens' RecentNearestSpeciesObservationsParams (Maybe Bool) recentNearestSpeciesObservationsParamsBack :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer) -- | Get a list of recent notable observations of some near some -- latitude/longitude. -- -- For example, get 5 notable observations within 25km of Capitol Reef -- National Park (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearbyNotableObservations key
--       38.366970 (-111.261504)
--       (def & #radius ?~ 25 & #maxResults ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearbyNotableObservations :: Text -> Double -> Double -> RecentNearbyNotableObservationsParams -> ClientM [SomeObservation] -- | Optional parameters accepted by the -- RecentNearbyNotableObservationsAPI. -- -- Note that defaultRecentNearbyNotableObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentNearbyNotableObservationsParamsRadius field to 10km: -- -- 
--   def & recentNearbyNotableObservationsParamsRadius ?~ 10
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #radius ?~ 10
--
data RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams :: Maybe Integer -> Maybe DetailLevel -> Maybe Integer -> Maybe Bool -> Maybe Integer -> Maybe SPPLocale -> RecentNearbyNotableObservationsParams -- | Search radius from the given latitude/longitude in kilometers -- -- 0 - 50, default: 25 [_recentNearbyNotableObservationsParamsRadius] :: RecentNearbyNotableObservationsParams -> Maybe Integer -- | Detail level for the resulting observations -- -- default: Simple [_recentNearbyNotableObservationsParamsDetail] :: RecentNearbyNotableObservationsParams -> Maybe DetailLevel -- | How many days back to look for observations -- -- 1 - 30, default: 14 [_recentNearbyNotableObservationsParamsBack] :: RecentNearbyNotableObservationsParams -> Maybe Integer -- | Only get observations from hotspots -- -- default: False [_recentNearbyNotableObservationsParamsHotspot] :: RecentNearbyNotableObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_recentNearbyNotableObservationsParamsMaxResults] :: RecentNearbyNotableObservationsParams -> Maybe Integer -- | Return observations with common names in this locale -- -- default: En [_recentNearbyNotableObservationsParamsLocale] :: RecentNearbyNotableObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentNearbyNotableObservationsParams :: RecentNearbyNotableObservationsParams recentNearbyNotableObservationsParamsRadius :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer) recentNearbyNotableObservationsParamsMaxResults :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer) recentNearbyNotableObservationsParamsLocale :: Lens' RecentNearbyNotableObservationsParams (Maybe SPPLocale) recentNearbyNotableObservationsParamsHotspot :: Lens' RecentNearbyNotableObservationsParams (Maybe Bool) recentNearbyNotableObservationsParamsDetail :: Lens' RecentNearbyNotableObservationsParams (Maybe DetailLevel) recentNearbyNotableObservationsParamsBack :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer) -- | Get a list of observations for each species seen on a specific date. -- -- For example, get a list of 10 fully detailed observations for each -- species seen on July 11th, 2023 in Park County, Wyoming (using -- -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $
--     historicalObservations key
--       "US-WY-029"
--       "2023-07-11"
--       (def & #maxResults ?~ 10 & #detail ?~ Full)
--
-- -- See the eBird API documentation for the corresponding endpoint. historicalObservations :: Text -> RegionCode -> EBirdDate -> HistoricalObservationsParams -> ClientM [SomeObservation] -- | Optional parameters accepted by the HistoricalObservationsAPI. -- -- Note that defaultHistoricalObservationsParams (or the -- Default instance's def value) may be used to accept the -- defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _historicalObservationsParamsDetail field to Full: -- -- 
--   def & historicalObservationsParamsDetail ?~ Full
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #detail ?~ Full
--
data HistoricalObservationsParams HistoricalObservationsParams :: Maybe TaxonomyCategories -> Maybe DetailLevel -> Maybe Bool -> Maybe Bool -> Maybe Integer -> Maybe SelectObservation -> Maybe RegionCode -> Maybe SPPLocale -> HistoricalObservationsParams -- | Only include observations in these taxonomy categories -- -- default: all [_historicalObservationsParamsCategories] :: HistoricalObservationsParams -> Maybe TaxonomyCategories -- | Detail level for the resulting observations -- -- default: Simple [_historicalObservationsParamsDetail] :: HistoricalObservationsParams -> Maybe DetailLevel -- | Only get observations from hotspots -- -- default: False [_historicalObservationsParamsHotspot] :: HistoricalObservationsParams -> Maybe Bool -- | Include observations which have not been reviewed -- -- default: False [_historicalObservationsParamsProvisional] :: HistoricalObservationsParams -> Maybe Bool -- | Maximum number of observations to get -- -- 1 - 10000, default: all [_historicalObservationsParamsMaxResults] :: HistoricalObservationsParams -> Maybe Integer -- | Whether to display the first or last observation of a species on the -- date, in the case that there are multiple observations of the same -- species on the date -- -- default: SelectLastObservation [_historicalObservationsParamsSelect] :: HistoricalObservationsParams -> Maybe SelectObservation -- | Up to 50 extra regions to get observations from -- -- default: none [_historicalObservationsParamsExtraRegions] :: HistoricalObservationsParams -> Maybe RegionCode -- | Return observations with common names in this locale -- -- default: En [_historicalObservationsParamsLocale] :: HistoricalObservationsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultHistoricalObservationsParams :: HistoricalObservationsParams historicalObservationsParamsSelect :: Lens' HistoricalObservationsParams (Maybe SelectObservation) historicalObservationsParamsProvisional :: Lens' HistoricalObservationsParams (Maybe Bool) historicalObservationsParamsMaxResults :: Lens' HistoricalObservationsParams (Maybe Integer) historicalObservationsParamsLocale :: Lens' HistoricalObservationsParams (Maybe SPPLocale) historicalObservationsParamsHotspot :: Lens' HistoricalObservationsParams (Maybe Bool) historicalObservationsParamsExtraRegions :: Lens' HistoricalObservationsParams (Maybe RegionCode) historicalObservationsParamsDetail :: Lens' HistoricalObservationsParams (Maybe DetailLevel) historicalObservationsParamsCategories :: Lens' HistoricalObservationsParams (Maybe TaxonomyCategories) instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories) => Optics.Label.LabelOptic "categories" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.DetailLevel, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.DetailLevel) => Optics.Label.LabelOptic "detail" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode) => Optics.Label.LabelOptic "extraRegions" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "provisional" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.SelectObservation, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.SelectObservation) => Optics.Label.LabelOptic "select" k Data.EBird.Client.Observations.HistoricalObservationsParams Data.EBird.Client.Observations.HistoricalObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.HistoricalObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.HistoricalObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.HistoricalObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.HistoricalObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.DetailLevel, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.DetailLevel) => Optics.Label.LabelOptic "detail" k Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "radius" k Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentNearbyNotableObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "provisional" k Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "radius" k Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentNearestSpeciesObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories) => Optics.Label.LabelOptic "categories" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "provisional" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "radius" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.SortObservationsBy, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.SortObservationsBy) => Optics.Label.LabelOptic "sortBy" k Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentNearbySpeciesObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories) => Optics.Label.LabelOptic "categories" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "provisional" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "radius" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.SortObservationsBy, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.SortObservationsBy) => Optics.Label.LabelOptic "sortBy" k Data.EBird.Client.Observations.RecentNearbyObservationsParams Data.EBird.Client.Observations.RecentNearbyObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentNearbyObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentNearbyObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentNearbyObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentNearbyObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentSpeciesObservationsParams Data.EBird.Client.Observations.RecentSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode) => Optics.Label.LabelOptic "extraRegions" k Data.EBird.Client.Observations.RecentSpeciesObservationsParams Data.EBird.Client.Observations.RecentSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentSpeciesObservationsParams Data.EBird.Client.Observations.RecentSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentSpeciesObservationsParams Data.EBird.Client.Observations.RecentSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentSpeciesObservationsParams Data.EBird.Client.Observations.RecentSpeciesObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "provisional" k Data.EBird.Client.Observations.RecentSpeciesObservationsParams Data.EBird.Client.Observations.RecentSpeciesObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentSpeciesObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentSpeciesObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentSpeciesObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentSpeciesObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentNotableObservationsParams Data.EBird.Client.Observations.RecentNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.DetailLevel, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Observations.DetailLevel) => Optics.Label.LabelOptic "detail" k Data.EBird.Client.Observations.RecentNotableObservationsParams Data.EBird.Client.Observations.RecentNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode) => Optics.Label.LabelOptic "extraRegions" k Data.EBird.Client.Observations.RecentNotableObservationsParams Data.EBird.Client.Observations.RecentNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentNotableObservationsParams Data.EBird.Client.Observations.RecentNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentNotableObservationsParams Data.EBird.Client.Observations.RecentNotableObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentNotableObservationsParams Data.EBird.Client.Observations.RecentNotableObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentNotableObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentNotableObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentNotableObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentNotableObservationsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "back" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories) => Optics.Label.LabelOptic "categories" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionCode) => Optics.Label.LabelOptic "extraRegions" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "hotspot" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool, b GHC.Types.~ GHC.Maybe.Maybe GHC.Types.Bool) => Optics.Label.LabelOptic "provisional" k Data.EBird.Client.Observations.RecentObservationsParams Data.EBird.Client.Observations.RecentObservationsParams a b instance GHC.Classes.Eq Data.EBird.Client.Observations.RecentObservationsParams instance GHC.Read.Read Data.EBird.Client.Observations.RecentObservationsParams instance GHC.Show.Show Data.EBird.Client.Observations.RecentObservationsParams instance Data.Default.Class.Default Data.EBird.Client.Observations.RecentObservationsParams -- | Types and functions for product-related eBird API queries. module Data.EBird.Client.Product -- | Get a list recently submitted checklists within a region. -- -- For example, get up to 3 recent checklists submitted in Park County, -- Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentChecklists key
--       "US-WY-029"
--       (def & #maxResults ?~ 3)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentChecklists :: Text -> RegionCode -> RecentChecklistsParams -> ClientM [ChecklistFeedEntry] -- | Optional parameters accepted by the RecentChecklistsAPI. -- -- Note that defaultRecentChecklistsParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _recentChecklistsParamsMaxResults field to 3: -- -- 
--   def & recentChecklistsParamsMaxResults ?~ 3
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #maxResults ?~ 3
--
newtype RecentChecklistsParams RecentChecklistsParams :: Maybe Integer -> RecentChecklistsParams -- | Maximum number of checklists to get -- -- 1 - 200, default: 10 [_recentChecklistsParamsMaxResults] :: RecentChecklistsParams -> Maybe Integer -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRecentChecklistsParams :: RecentChecklistsParams recentChecklistsParamsMaxResults :: Iso' RecentChecklistsParams (Maybe Integer) -- | Get a list of top contributors for a region on a specific date, ranked -- by number of species observed or number of checklists submitted. -- -- For example, get the top 10 contributors by number of species observed -- on July 11th, 2023 in Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     top100 key
--       "US-WY"
--       "2023-07-11"
--       (def & #maxResults ?~ 10)
--
-- -- See the eBird API documentation for the corresponding endpoint. top100 :: Text -> Region -> EBirdDate -> Top100Params -> ClientM [Top100ListEntry] -- | Optional parameters accepted by the Top100API. -- -- Note that defaultTop100Params (or the Default instance's -- def value) may be used to accept the defaults of the eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _top100ParamsMaxResults field to 50: -- -- 
--   def & top100ParamsMaxResults ?~ 50
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #maxResults ?~ 50
--
data Top100Params Top100Params :: Maybe RankTop100By -> Maybe Integer -> Top100Params -- | Rank the resulting list by number of species observed or by number of -- checklists completed -- -- default: RankTop100BySpecies [_top100ParamsRankBy] :: Top100Params -> Maybe RankTop100By -- | Maximum number of entries to fetch -- -- 1 - 100, default: 100 [_top100ParamsMaxResults] :: Top100Params -> Maybe Integer -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultTop100Params :: Top100Params top100ParamsRankBy :: Lens' Top100Params (Maybe RankTop100By) top100ParamsMaxResults :: Lens' Top100Params (Maybe Integer) -- | Get a list of checklists submitted within a region on a specific date. -- -- For example, get a feed of 10 checklists submitted in Park County, -- Wyoming on July 11th, 2023 (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     checklistFeed key
--       "US-WY-029"
--       "2023-07-11"
--       (def & #maxResults ?~ 10)
--
-- -- See the eBird API documentation for the corresponding endpoint. checklistFeed :: Text -> Region -> EBirdDate -> ChecklistFeedParams -> ClientM [ChecklistFeedEntry] -- | Optional parameters accepted by the ChecklistFeedAPI. -- -- Note that defaultChecklistFeedParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _checklistFeedParamsMaxResults field to 50: -- -- 
--   def & checklistFeedParamsMaxResults ?~ 50
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #maxResults ?~ 50
--
data ChecklistFeedParams ChecklistFeedParams :: Maybe SortChecklistsBy -> Maybe Integer -> ChecklistFeedParams -- | Sort the resulting list by date of checklist submission or date of -- checklist creation -- -- default: SortChecklistsByDateCreated [_checklistFeedParamsSortBy] :: ChecklistFeedParams -> Maybe SortChecklistsBy -- | Maximum number of checklists to get -- -- 1 - 200, default: 10 [_checklistFeedParamsMaxResults] :: ChecklistFeedParams -> Maybe Integer -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultChecklistFeedParams :: ChecklistFeedParams checklistFeedParamsSortBy :: Lens' ChecklistFeedParams (Maybe SortChecklistsBy) checklistFeedParamsMaxResults :: Lens' ChecklistFeedParams (Maybe Integer) -- | Get the RegionalStatistics for a region on a specific date. -- -- For example, get the statistics for Wyoming on July 11th, 2023 (using -- -XOverloadedStrings): -- -- 
--   askEBird $
--     regionalStatistics key
--       "US-WY"
--       "2023-07-11"
--
-- -- See the eBird API documentation for the corresponding endpoint. regionalStatistics :: Text -> Region -> EBirdDate -> ClientM RegionalStatistics -- | Get a list of all species ever seen in a Region. -- -- For example, get all species ever seen in Park County, Wyoming (using -- -XOverloadedStrings): -- -- 
--   askEBird $ speciesList key "US-WY-029"
--
-- -- Note that the endpoint for this query is simple enough that -- speciesList is equivalent to the generated speciesList_. -- -- See the eBird API documentation for the corresponding endpoint. speciesList :: Text -> Region -> ClientM [SpeciesCode] -- | Get information about a checklist. -- -- For example, get information for a checklist with submission ID -- "S144646447" (using -XOverloadedStrings): -- -- 
--   askEBird $ viewChecklist key S144646447
--
-- -- Note that the endpoint for this query is simple enough that -- viewChecklist is equivalent to the generated -- viewChecklist_. -- -- See the eBird API documentation for the corresponding endpoint. viewChecklist :: Text -> Text -> ClientM Checklist instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Product.ChecklistFeedParams Data.EBird.Client.Product.ChecklistFeedParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Checklists.SortChecklistsBy, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Checklists.SortChecklistsBy) => Optics.Label.LabelOptic "sortBy" k Data.EBird.Client.Product.ChecklistFeedParams Data.EBird.Client.Product.ChecklistFeedParams a b instance GHC.Classes.Eq Data.EBird.Client.Product.ChecklistFeedParams instance GHC.Read.Read Data.EBird.Client.Product.ChecklistFeedParams instance GHC.Show.Show Data.EBird.Client.Product.ChecklistFeedParams instance Data.Default.Class.Default Data.EBird.Client.Product.ChecklistFeedParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Product.Top100Params Data.EBird.Client.Product.Top100Params a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Product.RankTop100By, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Product.RankTop100By) => Optics.Label.LabelOptic "rankBy" k Data.EBird.Client.Product.Top100Params Data.EBird.Client.Product.Top100Params a b instance GHC.Classes.Eq Data.EBird.Client.Product.Top100Params instance GHC.Read.Read Data.EBird.Client.Product.Top100Params instance GHC.Show.Show Data.EBird.Client.Product.Top100Params instance Data.Default.Class.Default Data.EBird.Client.Product.Top100Params instance (k GHC.Types.~ Optics.Internal.Optic.Types.An_Iso, a GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer, b GHC.Types.~ GHC.Maybe.Maybe GHC.Num.Integer.Integer) => Optics.Label.LabelOptic "maxResults" k Data.EBird.Client.Product.RecentChecklistsParams Data.EBird.Client.Product.RecentChecklistsParams a b instance GHC.Classes.Eq Data.EBird.Client.Product.RecentChecklistsParams instance GHC.Read.Read Data.EBird.Client.Product.RecentChecklistsParams instance GHC.Show.Show Data.EBird.Client.Product.RecentChecklistsParams instance Data.Default.Class.Default Data.EBird.Client.Product.RecentChecklistsParams -- | Types and functions for region-related eBird API queries. module Data.EBird.Client.Regions -- | Get a RegionInfo for an eBird region. -- -- For example, get information about the Park County, Wyoming region -- (using -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $ regionInfo key "US-WY-029" def
--
-- -- See the eBird API documentation for the corresponding endpoint. regionInfo :: Text -> Region -> RegionInfoParams -> ClientM RegionInfo -- | Optional parameters accepted by the RegionInfoAPI. -- -- Note that defaultRegionInfoParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _regionInfoParamsFormat field to NameOnlyNameFormat -- (using -XOverloadedString): -- -- 
--   def & regionInfoParamsFormat ?~ "nameonly"
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #format ?~ "nameonly"
--
newtype RegionInfoParams RegionInfoParams :: Maybe RegionNameFormat -> RegionInfoParams -- | How to format the region name in the response -- -- default: Full [_regionInfoParamsFormat] :: RegionInfoParams -> Maybe RegionNameFormat -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultRegionInfoParams :: RegionInfoParams regionInfoParamsFormat :: Iso' RegionInfoParams (Maybe RegionNameFormat) -- | Get a list of subregions of a given region type within a given region. -- Keep in mind that many combinations of subregion and parent region are -- invalid, e.g. CountryType regions within "US-WY". -- -- For example, get county sub regions of Wyoming (using -- -XOverloadedStrings): -- -- 
--   askEBird $ subregionList key Subnational2Type "US-WY"
--
-- -- Note that the endpoint for this query is simple enough that -- subregionList is equivalent to the generated -- subregionList_. -- -- See the eBird API documentation for the corresponding endpoint. subregionList :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry] -- | Get a list of regions adjacent to a given region. Subnational2 -- region codes are only currently supported in the United States, New -- Zealand, or Mexico. -- -- For example, get regions adjacent to Wyoming (using -- -XOverloadedStrings): -- -- 
--   askEBird $ adjacentRegions key "US-WY"
--
-- -- Note that the endpoint for this query is simple enough that -- adjacentRegions is equivalent to the generated -- adjacentRegions_. -- -- See the eBird API documentation for the corresponding endpoint. adjacentRegions :: Text -> Region -> ClientM [RegionListEntry] instance (k GHC.Types.~ Optics.Internal.Optic.Types.An_Iso, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionNameFormat, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Regions.RegionNameFormat) => Optics.Label.LabelOptic "format" k Data.EBird.Client.Regions.RegionInfoParams Data.EBird.Client.Regions.RegionInfoParams a b instance GHC.Classes.Eq Data.EBird.Client.Regions.RegionInfoParams instance GHC.Read.Read Data.EBird.Client.Regions.RegionInfoParams instance GHC.Show.Show Data.EBird.Client.Regions.RegionInfoParams instance Data.Default.Class.Default Data.EBird.Client.Regions.RegionInfoParams -- | Types and functions for taxonomy-related eBird API queries. module Data.EBird.Client.Taxonomy -- | Get any version of the eBird taxonomy, with optional filtering based -- on taxonomy categories and species. -- -- For example, get the taxa for species in the "hybrid" category: -- -- 
--   askEBird $ taxonomy (def & #categories ?~ "hybrid")
--
-- -- See the eBird API documentation for the corresponding endpoint. taxonomy :: TaxonomyParams -> ClientM [Taxon] -- | Optional parameters accepted by the TaxonomyAPI. -- -- Note that defaultTaxonomyParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _taxonomyParamsSpecies field to "bohwax": -- -- 
--   def & taxonomyParamsSpecies ?~ "bohwax"
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #species ?~ "bohwax"
--
data TaxonomyParams TaxonomyParams :: Maybe TaxonomyCategories -> Maybe SPPLocale -> Maybe SpeciesCodes -> Maybe Text -> TaxonomyParams -- | Only include species of these TaxonomyCategorys in the taxonomy -- -- default: all categories [_taxonomyParamsCategories] :: TaxonomyParams -> Maybe TaxonomyCategories -- | Use this locale for common names -- -- default: En [_taxonomyParamsLocale] :: TaxonomyParams -> Maybe SPPLocale -- | Only fetch records for these species -- -- default: all [_taxonomyParamsSpecies] :: TaxonomyParams -> Maybe SpeciesCodes -- | Fetch this version of the eBird taxonomy -- -- default: latest [_taxonomyParamsVersion] :: TaxonomyParams -> Maybe Text -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultTaxonomyParams :: TaxonomyParams taxonomyParamsVersion :: Lens' TaxonomyParams (Maybe Text) taxonomyParamsSpecies :: Lens' TaxonomyParams (Maybe SpeciesCodes) taxonomyParamsLocale :: Lens' TaxonomyParams (Maybe SPPLocale) taxonomyParamsCategories :: Lens' TaxonomyParams (Maybe TaxonomyCategories) -- | Get the list of subspecies of a given species recognized in the eBird -- taxonomy. -- -- For example, get subspecies of Canada Goose (using -- -XOverloadedStrings): -- -- 
--   askEBird $ taxonomicForms key "cangoo"
--
-- -- Note that the endpoint for this query is simple enough that -- taxonomicForms is equivalent to the generated -- taxonomicForms_. -- -- See the eBird API documentation for the corresponding endpoint. taxonomicForms :: Text -> SpeciesCode -> ClientM SpeciesCodes -- | Get the supported locale codes and names for species common names, -- with the last time they were updated. -- -- For example: -- -- 
--   askEBird $ taxaLocaleCodes key def
--
-- -- See the eBird API documentation for the corresponding endpoint. taxaLocaleCodes :: Text -> TaxaLocaleCodesParams -> ClientM [SPPLocaleListEntry] -- | Optional parameters accepted by the TaxaLocaleCodesAPI. -- -- Note that defaultTaxaLocaleCodesParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _taxaLocaleCodesParamsLocale field to Es: -- -- 
--   def & taxaLocaleCodesParamsLocale ?~ Es
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #locale ?~ Es
--
newtype TaxaLocaleCodesParams TaxaLocaleCodesParams :: Maybe SPPLocale -> TaxaLocaleCodesParams -- | Value for the "Accept-Language" header, for translated language names, -- when available -- -- default: En [_taxaLocaleCodesParamsLocale] :: TaxaLocaleCodesParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultTaxaLocaleCodesParams :: TaxaLocaleCodesParams taxaLocaleCodesParamsLocale :: Iso' TaxaLocaleCodesParams (Maybe SPPLocale) -- | Get all versions of the taxonomy, with a flag indicating which is -- latest. -- -- For example: -- -- 
--   askEBird taxonomyVersions
--
-- -- Note that the endpoint for this query is simple enough that -- taxonomyVersions is equivalent to the generated -- taxonomyVersions_. -- -- See the eBird API documentation for the corresponding endpoint. taxonomyVersions :: ClientM [TaxonomyVersionListEntry] -- | Get the list of species groups, in either Merlin or eBird grouping. -- -- For example, get the taxonomic groups using eBird grouping order -- (using -XOverloadedStrings): -- -- 
--   askEBird $ taxonomicGroups "ebird" def
--
-- -- See the eBird API documentation for the corresponding endpoint. taxonomicGroups :: SPPGrouping -> TaxonomicGroupsParams -> ClientM [TaxonomicGroupListEntry] -- | Optional parameters accepted by the TaxonomicGroupsAPI. -- -- Note that defaultTaxonomicGroupsParams (or the Default -- instance's def value) may be used to accept the defaults of the -- eBird API. -- -- Additionally, note that there are optics available for manipulating -- this type. For example, if you would like to just set the -- _taxonomicGroupsParamsLocale field to Es: -- -- 
--   def & taxonomicGroupsParamsLocale ?~ Es
--
-- -- Or, using -XOverloadedLabels: -- -- 
--   def & #locale ?~ Es
--
newtype TaxonomicGroupsParams TaxonomicGroupsParams :: Maybe SPPLocale -> TaxonomicGroupsParams -- | Locale to use for species group names. En is used for any -- locale whose translations are unavailable at this endpoint -- -- default: En [_taxonomicGroupsParamsLocale] :: TaxonomicGroupsParams -> Maybe SPPLocale -- | Note that this value does not actually use the eBird API default -- values. It simply sets every option to Nothing, which means we -- just don't send any of these parameters to the eBird API and they will -- use their own defaults. defaultTaxonomicGroupsParams :: TaxonomicGroupsParams taxonomicGroupsParamsLocale :: Iso' TaxonomicGroupsParams (Maybe SPPLocale) instance (k GHC.Types.~ Optics.Internal.Optic.Types.An_Iso, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Taxonomy.TaxonomicGroupsParams Data.EBird.Client.Taxonomy.TaxonomicGroupsParams a b instance GHC.Classes.Eq Data.EBird.Client.Taxonomy.TaxonomicGroupsParams instance GHC.Read.Read Data.EBird.Client.Taxonomy.TaxonomicGroupsParams instance GHC.Show.Show Data.EBird.Client.Taxonomy.TaxonomicGroupsParams instance Data.Default.Class.Default Data.EBird.Client.Taxonomy.TaxonomicGroupsParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.An_Iso, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Taxonomy.TaxaLocaleCodesParams Data.EBird.Client.Taxonomy.TaxaLocaleCodesParams a b instance GHC.Classes.Eq Data.EBird.Client.Taxonomy.TaxaLocaleCodesParams instance GHC.Read.Read Data.EBird.Client.Taxonomy.TaxaLocaleCodesParams instance GHC.Show.Show Data.EBird.Client.Taxonomy.TaxaLocaleCodesParams instance Data.Default.Class.Default Data.EBird.Client.Taxonomy.TaxaLocaleCodesParams instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.TaxonomyCategories) => Optics.Label.LabelOptic "categories" k Data.EBird.Client.Taxonomy.TaxonomyParams Data.EBird.Client.Taxonomy.TaxonomyParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SPPLocale) => Optics.Label.LabelOptic "locale" k Data.EBird.Client.Taxonomy.TaxonomyParams Data.EBird.Client.Taxonomy.TaxonomyParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SpeciesCodes, b GHC.Types.~ GHC.Maybe.Maybe Data.EBird.API.Taxonomy.SpeciesCodes) => Optics.Label.LabelOptic "species" k Data.EBird.Client.Taxonomy.TaxonomyParams Data.EBird.Client.Taxonomy.TaxonomyParams a b instance (k GHC.Types.~ Optics.Internal.Optic.Types.A_Lens, a GHC.Types.~ GHC.Maybe.Maybe Data.Text.Internal.Text, b GHC.Types.~ GHC.Maybe.Maybe Data.Text.Internal.Text) => Optics.Label.LabelOptic "version" k Data.EBird.Client.Taxonomy.TaxonomyParams Data.EBird.Client.Taxonomy.TaxonomyParams a b instance GHC.Classes.Eq Data.EBird.Client.Taxonomy.TaxonomyParams instance GHC.Read.Read Data.EBird.Client.Taxonomy.TaxonomyParams instance GHC.Show.Show Data.EBird.Client.Taxonomy.TaxonomyParams instance Data.Default.Class.Default Data.EBird.Client.Taxonomy.TaxonomyParams -- | Functions that support querying the official eBird API as -- defined in the ebird-api library. module Data.EBird.Client -- | Send a request to the official eBird API. askEBird :: ClientM a -> IO (Either ClientError a) -- | Get a list of recent observations within a region. Results only -- include the most recent observation for each species in the region. -- -- For example, get up to 10 recent observations from the last 5 days in -- Park County, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentObservations key
--       "US-WY-029"
--       (def & #maxResults ?~ 10 & #back ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentObservations :: Text -> RegionCode -> RecentObservationsParams -> ClientM [Observation 'Simple] -- | Get a list of recent notable observations within a region. Results -- only include the most recent observation for each species in the -- region. -- -- For example, get up to 10 recent notable observations from the last 30 -- days in Park County, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNotableObservations key
--       "US-WY-029"
--       (def & #maxResults ?~ 10 & #back ?~ 30)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNotableObservations :: Text -> RegionCode -> RecentNotableObservationsParams -> ClientM [SomeObservation] -- | Get a list of recent observations within some radius of some -- latitude/longitude. -- -- For example, get up to 5 nearby observations within 10km of Cody, -- Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearbyObservations key
--       44.526340 (-109.056534)
--       (def & #maxResults ?~ 5 & #radius ?~ 10)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearbyObservations :: Text -> Double -> Double -> RecentNearbyObservationsParams -> ClientM [Observation 'Simple] -- | Get a list of recent observations of a species within some radius of -- some latitude/longitude. -- -- For example, get up to 5 nearby observations of Peregrine Falcons -- within 50km of Cody, Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearbySpeciesObservations key
--       "perfal"
--       44.526340 (-109.056534)
--       (def & #radius ?~ 50 & #maxResults ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearbySpeciesObservations :: Text -> SpeciesCode -> Double -> Double -> RecentNearbySpeciesObservationsParams -> ClientM [Observation 'Simple] -- | Get a list of recent observations of some species nearest to some -- latitude/longitude. -- -- For example, get the 5 nearest observations of Black-throated Gray -- Warblers within 50km of Capitol Reef National Park (using -- -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearestSpeciesObservations key
--       "btywar"
--       38.366970 (-111.261504)
--       (def & #radius ?~ 50 & #maxResults ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearestSpeciesObservations :: Text -> SpeciesCode -> Double -> Double -> RecentNearestSpeciesObservationsParams -> ClientM [Observation 'Simple] -- | Get a list of recent notable observations of some near some -- latitude/longitude. -- -- For example, get 5 notable observations within 25km of Capitol Reef -- National Park (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentNearbyNotableObservations key
--       38.366970 (-111.261504)
--       (def & #radius ?~ 25 & #maxResults ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentNearbyNotableObservations :: Text -> Double -> Double -> RecentNearbyNotableObservationsParams -> ClientM [SomeObservation] -- | Get a list of observations for each species seen on a specific date. -- -- For example, get a list of 10 fully detailed observations for each -- species seen on July 11th, 2023 in Park County, Wyoming (using -- -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $
--     historicalObservations key
--       "US-WY-029"
--       "2023-07-11"
--       (def & #maxResults ?~ 10 & #detail ?~ Full)
--
-- -- See the eBird API documentation for the corresponding endpoint. historicalObservations :: Text -> RegionCode -> EBirdDate -> HistoricalObservationsParams -> ClientM [SomeObservation] -- | Get a list recently submitted checklists within a region. -- -- For example, get up to 3 recent checklists submitted in Park County, -- Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     recentChecklists key
--       "US-WY-029"
--       (def & #maxResults ?~ 3)
--
-- -- See the eBird API documentation for the corresponding endpoint. recentChecklists :: Text -> RegionCode -> RecentChecklistsParams -> ClientM [ChecklistFeedEntry] -- | Get a list of top contributors for a region on a specific date, ranked -- by number of species observed or number of checklists submitted. -- -- For example, get the top 10 contributors by number of species observed -- on July 11th, 2023 in Wyoming (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     top100 key
--       "US-WY"
--       "2023-07-11"
--       (def & #maxResults ?~ 10)
--
-- -- See the eBird API documentation for the corresponding endpoint. top100 :: Text -> Region -> EBirdDate -> Top100Params -> ClientM [Top100ListEntry] -- | Get a list of checklists submitted within a region on a specific date. -- -- For example, get a feed of 10 checklists submitted in Park County, -- Wyoming on July 11th, 2023 (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     checklistFeed key
--       "US-WY-029"
--       "2023-07-11"
--       (def & #maxResults ?~ 10)
--
-- -- See the eBird API documentation for the corresponding endpoint. checklistFeed :: Text -> Region -> EBirdDate -> ChecklistFeedParams -> ClientM [ChecklistFeedEntry] -- | Get the RegionalStatistics for a region on a specific date. -- -- For example, get the statistics for Wyoming on July 11th, 2023 (using -- -XOverloadedStrings): -- -- 
--   askEBird $
--     regionalStatistics key
--       "US-WY"
--       "2023-07-11"
--
-- -- See the eBird API documentation for the corresponding endpoint. regionalStatistics :: Text -> Region -> EBirdDate -> ClientM RegionalStatistics -- | Get a list of all species ever seen in a Region. -- -- For example, get all species ever seen in Park County, Wyoming (using -- -XOverloadedStrings): -- -- 
--   askEBird $ speciesList key "US-WY-029"
--
-- -- Note that the endpoint for this query is simple enough that -- speciesList is equivalent to the generated speciesList_. -- -- See the eBird API documentation for the corresponding endpoint. speciesList :: Text -> Region -> ClientM [SpeciesCode] -- | Get information about a checklist. -- -- For example, get information for a checklist with submission ID -- "S144646447" (using -XOverloadedStrings): -- -- 
--   askEBird $ viewChecklist key S144646447
--
-- -- Note that the endpoint for this query is simple enough that -- viewChecklist is equivalent to the generated -- viewChecklist_. -- -- See the eBird API documentation for the corresponding endpoint. viewChecklist :: Text -> Text -> ClientM Checklist -- | Get all hotspots in a list of one or more regions (RegionCode). -- -- For example, get the hotspots in Albany County, Wyoming and Park -- County, Wyoming that have been visited in the last 5 days (using -- -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $ regionHotspots "US-WY-001,US-WY-029" (def & #back ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. regionHotspots :: RegionCode -> RegionHotspotsParams -> ClientM [Hotspot] -- | Get all hotspots within a radius of some latitude/longitude. -- -- For example, get the hotspots within 30km of Cody, Wyoming that have -- been visited in the last 5 days (using -XOverloadedLabels and -- -XOverloadedStrings): -- -- 
--   askEBird $
--     nearbyHotspots
--       44.526340 (-109.056534)
--       (def & #radius ?~ 30 & #back ?~ 5)
--
-- -- See the eBird API documentation for the corresponding endpoint. nearbyHotspots :: Double -> Double -> NearbyHotspotsParams -> ClientM [Hotspot] -- | Get information about a hotspot. -- -- For example, get information for a hotspot with location ID "L2373040" -- (using -XOverloadedStrings): -- -- 
--   askEBird $ hotspotInfo L2373040
--
-- -- Note that the endpoint for this query is simple enough that -- hotspotInfo is equivalent to the generated hotspotInfo_. -- -- See the eBird API documentation for the corresponding endpoint. hotspotInfo :: Text -> ClientM LocationData -- | Get any version of the eBird taxonomy, with optional filtering based -- on taxonomy categories and species. -- -- For example, get the taxa for species in the "hybrid" category: -- -- 
--   askEBird $ taxonomy (def & #categories ?~ "hybrid")
--
-- -- See the eBird API documentation for the corresponding endpoint. taxonomy :: TaxonomyParams -> ClientM [Taxon] -- | Get the list of subspecies of a given species recognized in the eBird -- taxonomy. -- -- For example, get subspecies of Canada Goose (using -- -XOverloadedStrings): -- -- 
--   askEBird $ taxonomicForms key "cangoo"
--
-- -- Note that the endpoint for this query is simple enough that -- taxonomicForms is equivalent to the generated -- taxonomicForms_. -- -- See the eBird API documentation for the corresponding endpoint. taxonomicForms :: Text -> SpeciesCode -> ClientM SpeciesCodes -- | Get the supported locale codes and names for species common names, -- with the last time they were updated. -- -- For example: -- -- 
--   askEBird $ taxaLocaleCodes key def
--
-- -- See the eBird API documentation for the corresponding endpoint. taxaLocaleCodes :: Text -> TaxaLocaleCodesParams -> ClientM [SPPLocaleListEntry] -- | Get all versions of the taxonomy, with a flag indicating which is -- latest. -- -- For example: -- -- 
--   askEBird taxonomyVersions
--
-- -- Note that the endpoint for this query is simple enough that -- taxonomyVersions is equivalent to the generated -- taxonomyVersions_. -- -- See the eBird API documentation for the corresponding endpoint. taxonomyVersions :: ClientM [TaxonomyVersionListEntry] -- | Get the list of species groups, in either Merlin or eBird grouping. -- -- For example, get the taxonomic groups using eBird grouping order -- (using -XOverloadedStrings): -- -- 
--   askEBird $ taxonomicGroups "ebird" def
--
-- -- See the eBird API documentation for the corresponding endpoint. taxonomicGroups :: SPPGrouping -> TaxonomicGroupsParams -> ClientM [TaxonomicGroupListEntry] -- | Get a RegionInfo for an eBird region. -- -- For example, get information about the Park County, Wyoming region -- (using -XOverloadedLabels and -XOverloadedStrings): -- -- 
--   askEBird $ regionInfo key "US-WY-029" def
--
-- -- See the eBird API documentation for the corresponding endpoint. regionInfo :: Text -> Region -> RegionInfoParams -> ClientM RegionInfo -- | Get a list of subregions of a given region type within a given region. -- Keep in mind that many combinations of subregion and parent region are -- invalid, e.g. CountryType regions within "US-WY". -- -- For example, get county sub regions of Wyoming (using -- -XOverloadedStrings): -- -- 
--   askEBird $ subregionList key Subnational2Type "US-WY"
--
-- -- Note that the endpoint for this query is simple enough that -- subregionList is equivalent to the generated -- subregionList_. -- -- See the eBird API documentation for the corresponding endpoint. subregionList :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry] -- | Get a list of regions adjacent to a given region. Subnational2 -- region codes are only currently supported in the United States, New -- Zealand, or Mexico. -- -- For example, get regions adjacent to Wyoming (using -- -XOverloadedStrings): -- -- 
--   askEBird $ adjacentRegions key "US-WY"
--
-- -- Note that the endpoint for this query is simple enough that -- adjacentRegions is equivalent to the generated -- adjacentRegions_. -- -- See the eBird API documentation for the corresponding endpoint. adjacentRegions :: Text -> Region -> ClientM [RegionListEntry] -- | A type representing possible errors in a request -- -- Note that this type substantially changed in 0.12. data () => ClientError