Twfy.Client

Documentation

type ApiKey = Text

API Key

data Client

Client - very subject to change, use the client function to create

Constructors

Client

Fields

• clientApiKey :: ApiKey

  API Key

• clientApiUri :: String

  API URL

• clientManager :: Manager

  HTTP client manager

• clientEnv :: ClientEnv

  Servant client env

Instances

Show Client

Methods

showsPrec :: Int -> Client -> ShowS

show :: Client -> String

showList :: [Client] -> ShowS

client

Arguments

:: ApiKey

API Key

-> Maybe String

API URI - defaults to "https://www.theyworkforyou.com/api"

-> Maybe Manager

HTTP Client manager - uses default TLS settings if not provided

-> IO Client

Create a client.

getConstituency

Arguments

:: Client

-> Maybe Text

Name

-> Maybe Text

Post code

-> IO (Either ServantError Constituency)

The getConstituency function retreives a constituency based on name or post code

getConstituencies :: Client -> IO (Either ServantError [Constituency])

The getConstituencies function retreives all constituencies

getMP

Arguments

:: Client

-> Maybe Int

Id

-> Maybe Text

Constituency name

-> Maybe Text

Post code

-> Maybe Bool

Always return

-> IO (Either ServantError MP)

The getMP function retreives an MP

getMPs

Arguments

:: Client

-> Maybe Text

Name search

-> Maybe Text

Party name

-> Maybe Text

Date

-> IO (Either ServantError [MP])

The getMPs function retreives a list of MPs