ebird-client 0.1.0.0 → 0.2.0.0
raw patch · 5 files changed
+24/−19 lines, 5 filesdep ~ebird-apiPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: ebird-api
API changes (from Hackage documentation)
- Data.EBird.Client: subRegionList :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry]
- Data.EBird.Client.Generated: subRegionList_ :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry]
- Data.EBird.Client.Regions: subRegionList :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry]
+ Data.EBird.Client: subregionList :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry]
+ Data.EBird.Client.Generated: subregionList_ :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry]
+ Data.EBird.Client.Regions: subregionList :: Text -> RegionType -> RegionCode -> ClientM [RegionListEntry]
Files
- CHANGELOG.md +5/−0
- ebird-client.cabal +2/−2
- src/Data/EBird/Client.hs +5/−5
- src/Data/EBird/Client/Generated.hs +5/−5
- src/Data/EBird/Client/Regions.hs +7/−7
CHANGELOG.md view
@@ -1,5 +1,10 @@ # Revision history for ebird-client +## 0.2.0.0 -- 2023-12-16++* Rename subregion items so that subregion is one word.+* Bump `ebird-api` constraint.+ ## 0.1.0.0 -- 2023-07-30 * First version. Released on an unsuspecting world.
ebird-client.cabal view
@@ -1,6 +1,6 @@ cabal-version: 3.0 name: ebird-client-version: 0.1.0.0+version: 0.2.0.0 synopsis: Client functions for querying the eBird API. description:@@ -57,7 +57,7 @@ Data.EBird.Client.Regions Data.EBird.Client.Taxonomy build-depends:- , ebird-api >= 0.1.0.0 && < 0.2+ , ebird-api >= 0.2.0.0 && < 0.3 , data-default >= 0.7.1.1 && < 0.8 , http-client-tls >= 0.3.5.3 && < 0.4
src/Data/EBird/Client.hs view
@@ -1,5 +1,5 @@ {-# LANGUAGE DataKinds #-}-{-# LANGUAGE TypeApplications #-}+ {-# OPTIONS_GHC -Wno-unrecognised-pragmas #-} {-# HLINT ignore "Eta reduce" #-} @@ -50,7 +50,7 @@ -- ** Region queries , regionInfo- , subRegionList+ , subregionList , adjacentRegions -- * Less convenient, generated queries@@ -76,8 +76,8 @@ askEBird :: ClientM a -> IO (Either ClientError a) askEBird question = do manager' <- newTlsManager- runClientM question (mkClientEnv manager' ebirdHQ)+ runClientM question (mkClientEnv manager' eBirdHQ) where -- Home of the official eBird API- ebirdHQ :: BaseUrl- ebirdHQ = BaseUrl Https "api.ebird.org" 443 ""+ eBirdHQ :: BaseUrl+ eBirdHQ = BaseUrl Https "api.ebird.org" 443 ""
src/Data/EBird/Client/Generated.hs view
@@ -1,7 +1,7 @@ {-# LANGUAGE DataKinds #-} {-# LANGUAGE TypeApplications #-} -{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}+{-# OPTIONS_GHC -Wno-unrecognised-pragmas -ddump-verbose-inlinings #-} {-# HLINT ignore "Eta reduce" #-} -- |@@ -56,7 +56,7 @@ -- ** Region queries , regionInfo_- , subRegionList_+ , subregionList_ , adjacentRegions_ ) where @@ -709,13 +709,13 @@ -- /default: 'Full'/ -> ClientM RegionInfo --- | Get a list of sub-regions of a given region type within a given region.+-- | 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](https://documenter.getpostman.com/view/664302/S1ENwy59#382da1c8-8bff-4926-936a-a1f8b065e7d5).-subRegionList_+subregionList_ :: Text -- ^ eBird API key -> RegionType@@ -760,5 +760,5 @@ :<|> taxonomyVersions_ :<|> taxonomicGroups_ :<|> regionInfo_- :<|> subRegionList_+ :<|> subregionList_ :<|> adjacentRegions_ = client (Proxy @EBirdAPI)
src/Data/EBird/Client/Regions.hs view
@@ -96,22 +96,22 @@ -- * Sub region list ------------------------------------------------------------------------------- --- | Get a list of sub-regions of a given region type within a given region.--- Keep in mind that many combinations of sub-region and parent region are+-- | 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"+-- askEBird $ subregionList key Subnational2Type "US-WY" -- @ ----- Note that the endpoint for this query is simple enough that 'subRegionList'--- is equivalent to the generated 'subRegionList_'.+-- 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](https://documenter.getpostman.com/view/664302/S1ENwy59#382da1c8-8bff-4926-936a-a1f8b065e7d5).-subRegionList+subregionList :: Text -- ^ eBird API key -> RegionType@@ -119,7 +119,7 @@ -> RegionCode -- ^ Parent 'RegionCode' -> ClientM [RegionListEntry]-subRegionList = subRegionList_+subregionList = subregionList_ ------------------------------------------------------------------------------- -- * Adjacent regions