Copyright	(C) 2016 Ismail Mustafa
License	BSD-style (see the file LICENSE)
Maintainer	Ismail Mustafa <ismailmustafa@rocketmail.com
Stability	provisional
Portability	OverloadedStrings
Safe Haskell	None
Language	Haskell2010

Network.Internal.Model

Description

Model definitions for the API wrapper.

Synopsis

data Credentials = Credentials {
- keyToken :: String
- secretToken :: String
}
data Handwriting = Handwriting {
- handwritingId :: Text
- title :: Text
- dateCreated :: Text
- dateModified :: Text
- ratingNeatness :: Double
- ratingCursivity :: Double
- ratingEmbellishment :: Double
- ratingCharacterWidth :: Double
}
data ImageParams = ImageParams {
- format :: Format
- width :: Maybe Double
- height :: Maybe Double
- hId :: Maybe String
- size :: Maybe Double
- color :: Maybe Color
- lineSpacing :: Maybe Double
- lineSpacingVariance :: Maybe Double
- wordSpacingVariance :: Maybe Double
- randomSeed :: RandomSeed
- pdfUnits :: PDFUnits
}
type Color = (Word8, Word8, Word8)
data Format
- = PNG
- | PDF
data PDFUnits
- = Points
- | Inches
data RandomSeed
- = Randomize
- | Repeatable
defaultImageParams :: ImageParams

Documentation

data Credentials #

Credentials that take and key and secret token.

Constructors

Credentials
Fields keyToken :: String secretToken :: String

Instances

Show Credentials #
Instance details Defined in Network.Internal.Model Methods showsPrec :: Int -> Credentials -> ShowS # show :: Credentials -> String # showList :: [Credentials] -> ShowS #

data Handwriting #

Handwriting data type that contains all the information about a specific handwriting style.

Constructors

Handwriting
Fields handwritingId :: Text title :: Text dateCreated :: Text dateModified :: Text ratingNeatness :: Double ratingCursivity :: Double ratingEmbellishment :: Double ratingCharacterWidth :: Double

Instances

Show Handwriting #	Pretty print the handwriting data type.
Instance details Defined in Network.Internal.Model Methods showsPrec :: Int -> Handwriting -> ShowS # show :: Handwriting -> String # showList :: [Handwriting] -> ShowS #
Generic Handwriting #
Instance details Defined in Network.Internal.Model Associated Types type Rep Handwriting :: * -> * # Methods from :: Handwriting -> Rep Handwriting x # to :: Rep Handwriting x -> Handwriting #
ToJSON Handwriting #
Instance details Defined in Network.Internal.Model Methods toJSON :: Handwriting -> Value # toEncoding :: Handwriting -> Encoding # toJSONList :: [Handwriting] -> Value # toEncodingList :: [Handwriting] -> Encoding #
FromJSON Handwriting #	Handwriting JSON instance.
Instance details Defined in Network.Internal.Model Methods parseJSON :: Value -> Parser Handwriting # parseJSONList :: Value -> Parser [Handwriting] #
type Rep Handwriting #
Instance details Defined in Network.Internal.Model type Rep Handwriting = D1 (MetaData "Handwriting" "Network.Internal.Model" "handwriting-0.1.0.3-IyrRkSyqRLH9n97qdQuKBM" False) (C1 (MetaCons "Handwriting" PrefixI True) (((S1 (MetaSel (Just "handwritingId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "title") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :: (S1 (MetaSel (Just "dateCreated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "dateModified") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :: ((S1 (MetaSel (Just "ratingNeatness") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double) :: S1 (MetaSel (Just "ratingCursivity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) :: (S1 (MetaSel (Just "ratingEmbellishment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double) :*: S1 (MetaSel (Just "ratingCharacterWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)))))

data ImageParams #

Optional image parameters that dictate different properties of the rendered image.

Constructors

ImageParams
Fields format :: Format width :: Maybe Double height :: Maybe Double hId :: Maybe String size :: Maybe Double color :: Maybe Color lineSpacing :: Maybe Double lineSpacingVariance :: Maybe Double wordSpacingVariance :: Maybe Double randomSeed :: RandomSeed pdfUnits :: PDFUnits

Instances

Show ImageParams #
Instance details Defined in Network.Internal.Model Methods showsPrec :: Int -> ImageParams -> ShowS # show :: ImageParams -> String # showList :: [ImageParams] -> ShowS #

type Color = (Word8, Word8, Word8) #

Color type representing (R,G,B).

data Format #

Format determines rendered image format in either png or pdf.

Constructors

PNG
PDF

Instances

Show Format #
Instance details Defined in Network.Internal.Model Methods showsPrec :: Int -> Format -> ShowS # show :: Format -> String # showList :: [Format] -> ShowS #

data PDFUnits #

PDFUnits is used to specify measurements when rendering a PDF.

Constructors

Points
Inches

Instances

Show PDFUnits #
Instance details Defined in Network.Internal.Model Methods showsPrec :: Int -> PDFUnits -> ShowS # show :: PDFUnits -> String # showList :: [PDFUnits] -> ShowS #

data RandomSeed #

RandomSeed is used to specify if every rendered image called with the same parameters should render differently or the same each time.

Constructors

Randomize
Repeatable

Instances

Show RandomSeed #
Instance details Defined in Network.Internal.Model Methods showsPrec :: Int -> RandomSeed -> ShowS # show :: RandomSeed -> String # showList :: [RandomSeed] -> ShowS #

defaultImageParams :: ImageParams #

Default image parameters provided for convenience.