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

Monadic

runPinboard :: MonadIO 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 (Either PinboardError (Response ByteString))

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

runPinboardSingleJson :: (Functor m, MonadIO 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 :: MonadIO m => PinboardErrorType -> SomeException -> m (Either PinboardError b)

JSON Handling

parseJSONResponse :: (MonadError PinboardError m, FromJSON a) => Response ByteString -> m a

decodeJSONResponse :: (MonadError PinboardError m, FromJSON a) => ByteString -> m 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

module Pinboard.Error

module Pinboard.Types

module Pinboard.Util