Network.Internal.Model

Model definitions for the API wrapper.

Documentation

data Credentials

Credentials that take and key and secret token.

Constructors

Credentials

Fields

keyToken :: String

secretToken :: String

Instances

Show Credentials

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.

Generic Handwriting

ToJSON Handwriting

FromJSON Handwriting

Handwriting JSON instance.

type Rep Handwriting

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

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

data PDFUnits

PDFUnits is used to specify measurements when rendering a PDF.

Constructors

Points

Inches

Instances

Show PDFUnits

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

defaultImageParams :: ImageParams

Default image parameters provided for convenience.