Fixer.Types

Types for the API

Documentation

newtype Rate

A positive and non-0 ratio

Constructors

Rate

Fields

• unRate :: Ratio Natural

Instances

Eq Rate

Methods

(==) :: Rate -> Rate -> Bool

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

Show Rate

Methods

showsPrec :: Int -> Rate -> ShowS

show :: Rate -> String

showList :: [Rate] -> ShowS

Generic Rate

Associated Types

type Rep Rate :: * -> *

Methods

from :: Rate -> Rep Rate x

to :: Rep Rate x -> Rate

ToJSON Rate

Methods

toJSON :: Rate -> Value

toEncoding :: Rate -> Encoding

toJSONList :: [Rate] -> Value

toEncodingList :: [Rate] -> Encoding

FromJSON Rate

Methods

parseJSON :: Value -> Parser Rate

parseJSONList :: Value -> Parser [Rate]

Validity Rate

A rate is valid if:

• The ratio inside is valid.
• The ratio is not zero.
• The ratio is normalised.

Methods

validate :: Rate -> Validation

isValid :: Rate -> Bool

type Rep Rate

type Rep Rate = D1 * (MetaData "Rate" "Fixer.Types" "fixer-0.0.0.0-KyDvPt0WkGj3Gzgyze5650" True) (C1 * (MetaCons "Rate" PrefixI True) (S1 * (MetaSel (Just Symbol "unRate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Ratio Natural))))

oneRate :: Rate

The identity of mulRate

mulRate :: Rate -> Rate -> Rate

Multiply two rates

divRate :: Rate -> Rate -> Rate

Divide one rate by another

normaliseRate :: Rate -> Rate

Ensure that a rate is internally normalised. This is a requirement for Validity

rateToRational :: Rate -> Rational

Convert a rate to a 'Ratio Integer' instead of 'Ratio Natural'.

This is a lossless transformation.

rateToDouble :: Rate -> Double

Convert a rate to a Double.

This may not be a lossless transformation

data Currency

A sum-type of the supported currencies on fixer.io

Constructors

AUD

BGN

BRL

CAD

CHF

CNY

CZK

DKK

EUR

GBP

HKD

HRK

HUF

IDR

ILS

INR

JPY

KRW

MXN

MYR

NOK

NZD

PHP

PLN

RON

RUB

SEK

SGD

THB

TRY

USD

ZAR

Instances

Bounded Currency

Methods

minBound :: Currency

maxBound :: Currency

Enum Currency

Methods

succ :: Currency -> Currency

pred :: Currency -> Currency

toEnum :: Int -> Currency

fromEnum :: Currency -> Int

enumFrom :: Currency -> [Currency]

enumFromThen :: Currency -> Currency -> [Currency]

enumFromTo :: Currency -> Currency -> [Currency]

enumFromThenTo :: Currency -> Currency -> Currency -> [Currency]

Eq Currency

Methods

(==) :: Currency -> Currency -> Bool

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

Ord Currency

Methods

compare :: Currency -> Currency -> Ordering

(<) :: Currency -> Currency -> Bool

(<=) :: Currency -> Currency -> Bool

(>) :: Currency -> Currency -> Bool

(>=) :: Currency -> Currency -> Bool

max :: Currency -> Currency -> Currency

min :: Currency -> Currency -> Currency

Read Currency

Methods

readsPrec :: Int -> ReadS Currency

readList :: ReadS [Currency]

readPrec :: ReadPrec Currency

readListPrec :: ReadPrec [Currency]

Show Currency

Methods

showsPrec :: Int -> Currency -> ShowS

show :: Currency -> String

showList :: [Currency] -> ShowS

Generic Currency

Associated Types

type Rep Currency :: * -> *

Methods

from :: Currency -> Rep Currency x

to :: Rep Currency x -> Currency

ToJSON Currency

Methods

toJSON :: Currency -> Value

toEncoding :: Currency -> Encoding

toJSONList :: [Currency] -> Value

toEncodingList :: [Currency] -> Encoding

ToJSONKey Currency

Methods

toJSONKey :: ToJSONKeyFunction Currency

toJSONKeyList :: ToJSONKeyFunction [Currency]

FromJSON Currency

Methods

parseJSON :: Value -> Parser Currency

parseJSONList :: Value -> Parser [Currency]

FromJSONKey Currency

Methods

fromJSONKey :: FromJSONKeyFunction Currency

fromJSONKeyList :: FromJSONKeyFunction [Currency]

ToHttpApiData Currency

Methods

toUrlPiece :: Currency -> Text

toEncodedUrlPiece :: Currency -> Builder

toHeader :: Currency -> ByteString

toQueryParam :: Currency -> Text

Validity Currency

Methods

validate :: Currency -> Validation

isValid :: Currency -> Bool

type Rep Currency

type Rep Currency = D1 * (MetaData "Currency" "Fixer.Types" "fixer-0.0.0.0-KyDvPt0WkGj3Gzgyze5650" False) ((:+:) * ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "AUD" PrefixI False) (U1 *)) (C1 * (MetaCons "BGN" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "BRL" PrefixI False) (U1 *)) (C1 * (MetaCons "CAD" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "CHF" PrefixI False) (U1 *)) (C1 * (MetaCons "CNY" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "CZK" PrefixI False) (U1 *)) (C1 * (MetaCons "DKK" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "EUR" PrefixI False) (U1 *)) (C1 * (MetaCons "GBP" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "HKD" PrefixI False) (U1 *)) (C1 * (MetaCons "HRK" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "HUF" PrefixI False) (U1 *)) (C1 * (MetaCons "IDR" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "ILS" PrefixI False) (U1 *)) (C1 * (MetaCons "INR" PrefixI False) (U1 *)))))) ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "JPY" PrefixI False) (U1 *)) (C1 * (MetaCons "KRW" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "MXN" PrefixI False) (U1 *)) (C1 * (MetaCons "MYR" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "NOK" PrefixI False) (U1 *)) (C1 * (MetaCons "NZD" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "PHP" PrefixI False) (U1 *)) (C1 * (MetaCons "PLN" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "RON" PrefixI False) (U1 *)) (C1 * (MetaCons "RUB" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "SEK" PrefixI False) (U1 *)) (C1 * (MetaCons "SGD" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "THB" PrefixI False) (U1 *)) (C1 * (MetaCons "TRY" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "USD" PrefixI False) (U1 *)) (C1 * (MetaCons "ZAR" PrefixI False) (U1 *)))))))

newtype Symbols

A nonempty list of Currencys

Constructors

Symbols

Fields

• unSymbols :: NonEmpty Currency

Instances

Eq Symbols

Methods

(==) :: Symbols -> Symbols -> Bool

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

Ord Symbols

Methods

compare :: Symbols -> Symbols -> Ordering

(<) :: Symbols -> Symbols -> Bool

(<=) :: Symbols -> Symbols -> Bool

(>) :: Symbols -> Symbols -> Bool

(>=) :: Symbols -> Symbols -> Bool

max :: Symbols -> Symbols -> Symbols

min :: Symbols -> Symbols -> Symbols

Show Symbols

Methods

showsPrec :: Int -> Symbols -> ShowS

show :: Symbols -> String

showList :: [Symbols] -> ShowS

Generic Symbols

Associated Types

type Rep Symbols :: * -> *

Methods

from :: Symbols -> Rep Symbols x

to :: Rep Symbols x -> Symbols

ToHttpApiData Symbols

Methods

toUrlPiece :: Symbols -> Text

toEncodedUrlPiece :: Symbols -> Builder

toHeader :: Symbols -> ByteString

toQueryParam :: Symbols -> Text

Validity Symbols

Methods

validate :: Symbols -> Validation

isValid :: Symbols -> Bool

type Rep Symbols

type Rep Symbols = D1 * (MetaData "Symbols" "Fixer.Types" "fixer-0.0.0.0-KyDvPt0WkGj3Gzgyze5650" True) (C1 * (MetaCons "Symbols" PrefixI True) (S1 * (MetaSel (Just Symbol "unSymbols") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (NonEmpty Currency))))

data Rates

The raw response of fixer.io

Constructors

Rates

Fields

• ratesBase :: Currency
• ratesDate :: Day
• ratesRates :: Map Currency Rate

Instances

Eq Rates

Methods

(==) :: Rates -> Rates -> Bool

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

Show Rates

Methods

showsPrec :: Int -> Rates -> ShowS

show :: Rates -> String

showList :: [Rates] -> ShowS

Generic Rates

Associated Types

type Rep Rates :: * -> *

Methods

from :: Rates -> Rep Rates x

to :: Rep Rates x -> Rates

FromJSON Rates

Methods

parseJSON :: Value -> Parser Rates

parseJSONList :: Value -> Parser [Rates]

Validity Rates

Methods

validate :: Rates -> Validation

isValid :: Rates -> Bool

type Rep Rates

type Rep Rates = D1 * (MetaData "Rates" "Fixer.Types" "fixer-0.0.0.0-KyDvPt0WkGj3Gzgyze5650" False) (C1 * (MetaCons "Rates" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "ratesBase") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Currency)) ((:*:) * (S1 * (MetaSel (Just Symbol "ratesDate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Day)) (S1 * (MetaSel (Just Symbol "ratesRates") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map Currency Rate))))))