Copyright	(c) Hardy Jones 2017
License	BSD3
Maintainer	jones3.hardy@gmail.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Rollbar.API

Contents

Helpful functions
Response data types
Impure functions

Description

Provides functions for communicating with Rollbar through the public API.

See Rollbar's API for more details.

Synopsis

itemsPOST :: (MonadIO f, RemoveHeaders b, ToJSON a) => Item a b -> f (Response (Either JSONException ItemsPOSTResponse))
itemsPOST' :: (MonadIO f, RemoveHeaders b, ToJSON a) => Manager -> Item a b -> f (Response (Either JSONException ItemsPOSTResponse))
itemsPOSTRaw :: (FromJSON c, MonadIO f, RemoveHeaders b, ToJSON a) => Item a b -> f (Response (Either JSONException c))
itemsPOSTRaw' :: (FromJSON c, MonadIO f, RemoveHeaders b, ToJSON a) => Manager -> Item a b -> f (Response (Either JSONException c))
makeRequest :: (RemoveHeaders headers, ToJSON a) => Item a headers -> Request
data ItemsPOSTResponse
- = ItemsPOSTSuccess {
  - err_ItemsPOSTSuccess :: Int
  - result_ItemsPOSTSuccess :: ItemsPOSTSuccessResult
  }
- | ItemsPOSTError {
  - err_ItemsPOSTError :: Int
  - message_ItemsPOSTError :: Text
  }
newtype ItemsPOSTErrorMessage = ItemsPOSTErrorMessage Text
newtype ItemsPOSTSuccessResult = ItemsPOSTSuccessResult {
- uuid :: UUID4
}
itemsPOSTWithException :: (FromJSON c, MonadIO f, RemoveHeaders b, ToJSON a) => Item a b -> f (Response c)

Helpful functions

These functions are probably what you want most of the time.

itemsPOST :: (MonadIO f, RemoveHeaders b, ToJSON a) => Item a b -> f (Response (Either JSONException ItemsPOSTResponse)) Source #

Sends an Item off to Rollbar.

Creates a new Manager to send off the request.

itemsPOST' :: (MonadIO f, RemoveHeaders b, ToJSON a) => Manager -> Item a b -> f (Response (Either JSONException ItemsPOSTResponse)) Source #

Sends an Item off to Rollbar.

itemsPOSTRaw :: (FromJSON c, MonadIO f, RemoveHeaders b, ToJSON a) => Item a b -> f (Response (Either JSONException c)) Source #

Sends an Item off to Rollbar.

Creates a new Manager to send off the request. Makes no claims about what you get back.

itemsPOSTRaw' :: (FromJSON c, MonadIO f, RemoveHeaders b, ToJSON a) => Manager -> Item a b -> f (Response (Either JSONException c)) Source #

Sends an Item off to Rollbar.

Makes no claims about what you get back.

makeRequest :: (RemoveHeaders headers, ToJSON a) => Item a headers -> Request Source #

Converts an item into a request ready to send to Rollbar.

If you need a different scheme for sending items, you'll probably want to use this along with a function like httpLbs or httpLbs.

If you want the JSON back and already have a Manager, you can use this function with setRequestManager. Then send off the request with something like httpJSONEither.

Response data types

data ItemsPOSTResponse Source #

The response received from sending an Item to Rollbar.

Constructors

ItemsPOSTSuccess
Fields err_ItemsPOSTSuccess :: Int This `err` field is always 0. result_ItemsPOSTSuccess :: ItemsPOSTSuccessResult The part you probably care about.
ItemsPOSTError
Fields err_ItemsPOSTError :: Int This `err` field is always 1. message_ItemsPOSTError :: Text A human-readable message describing the error.

Instances

Eq ItemsPOSTResponse Source #
Instance details Defined in Rollbar.API Methods (==) :: ItemsPOSTResponse -> ItemsPOSTResponse -> Bool # (/=) :: ItemsPOSTResponse -> ItemsPOSTResponse -> Bool #
Show ItemsPOSTResponse Source #
Instance details Defined in Rollbar.API Methods showsPrec :: Int -> ItemsPOSTResponse -> ShowS # show :: ItemsPOSTResponse -> String # showList :: [ItemsPOSTResponse] -> ShowS #
Generic ItemsPOSTResponse Source #
Instance details Defined in Rollbar.API Associated Types type Rep ItemsPOSTResponse :: * -> * # Methods from :: ItemsPOSTResponse -> Rep ItemsPOSTResponse x # to :: Rep ItemsPOSTResponse x -> ItemsPOSTResponse #
FromJSON ItemsPOSTResponse Source #
Instance details Defined in Rollbar.API Methods parseJSON :: Value -> Parser ItemsPOSTResponse # parseJSONList :: Value -> Parser [ItemsPOSTResponse] #
type Rep ItemsPOSTResponse Source #
Instance details Defined in Rollbar.API type Rep ItemsPOSTResponse = D1 (MetaData "ItemsPOSTResponse" "Rollbar.API" "rollbar-hs-0.3.1.0-AHXin9WUqD3IOtR3mTqHpy" False) (C1 (MetaCons "ItemsPOSTSuccess" PrefixI True) (S1 (MetaSel (Just "err_ItemsPOSTSuccess") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "result_ItemsPOSTSuccess") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ItemsPOSTSuccessResult)) :+: C1 (MetaCons "ItemsPOSTError" PrefixI True) (S1 (MetaSel (Just "err_ItemsPOSTError") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "message_ItemsPOSTError") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ItemsPOSTErrorMessage Source #

The human readable error message from sending an Item to Rollbar.

Constructors

ItemsPOSTErrorMessage Text

Instances

Eq ItemsPOSTErrorMessage Source #
Instance details Defined in Rollbar.API Methods (==) :: ItemsPOSTErrorMessage -> ItemsPOSTErrorMessage -> Bool # (/=) :: ItemsPOSTErrorMessage -> ItemsPOSTErrorMessage -> Bool #
Show ItemsPOSTErrorMessage Source #
Instance details Defined in Rollbar.API Methods showsPrec :: Int -> ItemsPOSTErrorMessage -> ShowS # show :: ItemsPOSTErrorMessage -> String # showList :: [ItemsPOSTErrorMessage] -> ShowS #
Generic ItemsPOSTErrorMessage Source #
Instance details Defined in Rollbar.API Associated Types type Rep ItemsPOSTErrorMessage :: * -> * # Methods from :: ItemsPOSTErrorMessage -> Rep ItemsPOSTErrorMessage x # to :: Rep ItemsPOSTErrorMessage x -> ItemsPOSTErrorMessage #
FromJSON ItemsPOSTErrorMessage Source #
Instance details Defined in Rollbar.API Methods parseJSON :: Value -> Parser ItemsPOSTErrorMessage # parseJSONList :: Value -> Parser [ItemsPOSTErrorMessage] #
type Rep ItemsPOSTErrorMessage Source #
Instance details Defined in Rollbar.API type Rep ItemsPOSTErrorMessage = D1 (MetaData "ItemsPOSTErrorMessage" "Rollbar.API" "rollbar-hs-0.3.1.0-AHXin9WUqD3IOtR3mTqHpy" True) (C1 (MetaCons "ItemsPOSTErrorMessage" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ItemsPOSTSuccessResult Source #

The successful response from sending an Item to Rollbar.

Constructors

ItemsPOSTSuccessResult
Fields uuid :: UUID4 `UUID4` of the item. Matches sent `UUID4` or generated by Rollbar if missing.

Instances

Eq ItemsPOSTSuccessResult Source #
Instance details Defined in Rollbar.API Methods (==) :: ItemsPOSTSuccessResult -> ItemsPOSTSuccessResult -> Bool # (/=) :: ItemsPOSTSuccessResult -> ItemsPOSTSuccessResult -> Bool #
Show ItemsPOSTSuccessResult Source #
Instance details Defined in Rollbar.API Methods showsPrec :: Int -> ItemsPOSTSuccessResult -> ShowS # show :: ItemsPOSTSuccessResult -> String # showList :: [ItemsPOSTSuccessResult] -> ShowS #
Generic ItemsPOSTSuccessResult Source #
Instance details Defined in Rollbar.API Associated Types type Rep ItemsPOSTSuccessResult :: * -> * # Methods from :: ItemsPOSTSuccessResult -> Rep ItemsPOSTSuccessResult x # to :: Rep ItemsPOSTSuccessResult x -> ItemsPOSTSuccessResult #
FromJSON ItemsPOSTSuccessResult Source #
Instance details Defined in Rollbar.API Methods parseJSON :: Value -> Parser ItemsPOSTSuccessResult # parseJSONList :: Value -> Parser [ItemsPOSTSuccessResult] #
type Rep ItemsPOSTSuccessResult Source #
Instance details Defined in Rollbar.API type Rep ItemsPOSTSuccessResult = D1 (MetaData "ItemsPOSTSuccessResult" "Rollbar.API" "rollbar-hs-0.3.1.0-AHXin9WUqD3IOtR3mTqHpy" True) (C1 (MetaCons "ItemsPOSTSuccessResult" PrefixI True) (S1 (MetaSel (Just "uuid") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UUID4)))

Impure functions

Use with caution.

itemsPOSTWithException :: (FromJSON c, MonadIO f, RemoveHeaders b, ToJSON a) => Item a b -> f (Response c) Source #

Sends an Item off to Rollbar.

Creates a new Manager to send off the request. Makes no claims about what you get back. Throws a JSONException if it cannot parse the response.

Yes, this name is annoying, so are exceptions.