Ziptastic.Core

This module provides a complete and type-safe API specification for Ziptastic's forward and reverse geocoding API using Servant (https://www.getziptastic.com/).

To use this specification in your application, try the ziptastic-client package.

Documentation

type Api = "v3" :> (Header "x-key" ApiKey :> ApiEndpoints)

newtype ApiKey

Constructors

ApiKey

Fields

• getApiKey :: Text

Instances

Eq ApiKey

Methods

(==) :: ApiKey -> ApiKey -> Bool

(/=) :: ApiKey -> ApiKey -> Bool

Show ApiKey

Methods

showsPrec :: Int -> ApiKey -> ShowS

show :: ApiKey -> String

showList :: [ApiKey] -> ShowS

IsString ApiKey

Methods

fromString :: String -> ApiKey

Generic ApiKey

Associated Types

type Rep ApiKey :: * -> *

Methods

from :: ApiKey -> Rep ApiKey x

to :: Rep ApiKey x -> ApiKey

ToHttpApiData ApiKey

Methods

toUrlPiece :: ApiKey -> Text

toHeader :: ApiKey -> ByteString

toQueryParam :: ApiKey -> Text

type Rep ApiKey

type Rep ApiKey = D1 (MetaData "ApiKey" "Ziptastic.Core" "ziptastic-core-0.2.0.1-uTSzfdGQhR97oRWrUTSCj" True) (C1 (MetaCons "ApiKey" PrefixI True) (S1 (MetaSel (Just Symbol "getApiKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ForApi a

A generic wrapper for giving external data types instances for our uses.

Constructors

ForApi a

Instances

ToHttpApiData (ForApi CountryCode)

Methods

toUrlPiece :: ForApi CountryCode -> Text

toHeader :: ForApi CountryCode -> ByteString

toQueryParam :: ForApi CountryCode -> Text

data LocaleCoords

Constructors

LocaleCoords

Fields

• coordsLatitude :: Double
• coordsLongitude :: Double
• coordsGeohash :: Text

  Will never be empty.

Instances

Eq LocaleCoords

Methods

(==) :: LocaleCoords -> LocaleCoords -> Bool

(/=) :: LocaleCoords -> LocaleCoords -> Bool

Show LocaleCoords

Methods

showsPrec :: Int -> LocaleCoords -> ShowS

show :: LocaleCoords -> String

showList :: [LocaleCoords] -> ShowS

Generic LocaleCoords

Associated Types

type Rep LocaleCoords :: * -> *

Methods

from :: LocaleCoords -> Rep LocaleCoords x

to :: Rep LocaleCoords x -> LocaleCoords

type Rep LocaleCoords

type Rep LocaleCoords = D1 (MetaData "LocaleCoords" "Ziptastic.Core" "ziptastic-core-0.2.0.1-uTSzfdGQhR97oRWrUTSCj" False) (C1 (MetaCons "LocaleCoords" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "coordsLatitude") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) ((:*:) (S1 (MetaSel (Just Symbol "coordsLongitude") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) (S1 (MetaSel (Just Symbol "coordsGeohash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

data LocaleInfo

Constructors

LocaleInfo

Fields

• localeCity :: Maybe Text

  If given, text will never be empty.

• localeCoords :: Maybe LocaleCoords
• localeCountry :: CountryCode
• localeCounty :: Maybe Text

  If given, text will never be empty.

• localeRegionFull :: Maybe Text

  In the US, this is a state name (e.g. Michigan). If given, text will never be empty.

• localeRegionAbbrev :: Maybe Text

  In the US, this is a state abbreviation (e.g. MI). If given, text will never be empty.

• localePostalCode :: Text

  I.e. zip code. Text will never be empty.

• localeTimeZone :: Maybe TZLabel

Instances

Eq LocaleInfo

Methods

(==) :: LocaleInfo -> LocaleInfo -> Bool

(/=) :: LocaleInfo -> LocaleInfo -> Bool

Show LocaleInfo

Methods

showsPrec :: Int -> LocaleInfo -> ShowS

show :: LocaleInfo -> String

showList :: [LocaleInfo] -> ShowS

Generic LocaleInfo

Associated Types

type Rep LocaleInfo :: * -> *

Methods

from :: LocaleInfo -> Rep LocaleInfo x

to :: Rep LocaleInfo x -> LocaleInfo

FromJSON LocaleInfo

Methods

parseJSON :: Value -> Parser LocaleInfo

parseJSONList :: Value -> Parser [LocaleInfo]

type Rep LocaleInfo

type Rep LocaleInfo = D1 (MetaData "LocaleInfo" "Ziptastic.Core" "ziptastic-core-0.2.0.1-uTSzfdGQhR97oRWrUTSCj" False) (C1 (MetaCons "LocaleInfo" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "localeCity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "localeCoords") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe LocaleCoords)))) ((:*:) (S1 (MetaSel (Just Symbol "localeCountry") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CountryCode)) (S1 (MetaSel (Just Symbol "localeCounty") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "localeRegionFull") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "localeRegionAbbrev") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "localePostalCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "localeTimeZone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe TZLabel)))))))

baseUrlHost :: String

baseUrlPath :: String