Pinboard.Client

Config

fromApiToken :: String -> PinboardConfig

Create a default PinboardConfig using the supplied apiToken

The PinboardConfig provides authentication via apiToken

data PinboardConfig

Constructors

PinboardConfig

Fields

• apiToken :: !ByteString

Instances

Show PinboardConfig

Methods

showsPrec :: Int -> PinboardConfig -> ShowS

show :: PinboardConfig -> String

showList :: [PinboardConfig] -> ShowS

Monadic

runPinboard :: (MonadIO m, MonadCatch m) => PinboardConfig -> PinboardT m a -> m (Either PinboardError a)

Execute computations in the Pinboard monad

pinboardJson :: (MonadPinboard m, FromJSON a) => PinboardRequest -> m a

Create a Pinboard value from a PinboardRequest w/ json deserialization

Single

runPinboardSingleRaw :: MonadIO m => PinboardConfig -> PinboardRequest -> m (Response ByteString)

runPinboardSingleRawBS :: MonadIO m => PinboardConfig -> PinboardRequest -> m (Either PinboardError ByteString)

runPinboardSingleJson :: (MonadIO m, MonadCatch m, FromJSON a) => PinboardConfig -> PinboardRequest -> m (Either PinboardError a)

Sending

sendPinboardRequest :: MonadIO m => PinboardEnv -> PinboardRequest -> m (Response ByteString)

Manager (http-client)

newMgr :: MonadIO m => m Manager

mgrFail :: Monad m => PinboardErrorType -> SomeException -> m (Either PinboardError b)

JSON Handling

parseJSONResponse :: FromJSON a => Response ByteString -> Either PinboardError a

decodeJSONResponse :: FromJSON a => ByteString -> Either PinboardError a

Status Codes

checkStatusCodeResponse :: Response a -> Either PinboardError ()

checkStatusCode :: Int -> Either PinboardError ()

Error Helpers

addErrMsg :: Text -> PinboardError -> PinboardError

createParserErr :: Text -> PinboardError

httpStatusPinboardError :: PinboardErrorHTTPCode -> Either PinboardError a

Client Dependencies