Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetEventsId

Description

Contains the different functions to run the operation getEventsId

Synopsis

getEventsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetEventsIdRequestBody -> m (Either HttpException (Response GetEventsIdResponse))
getEventsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetEventsIdRequestBody -> m (Either HttpException (Response ByteString))
getEventsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetEventsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetEventsIdResponse))
getEventsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetEventsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetEventsIdRequestBody = GetEventsIdRequestBody {
}
data GetEventsIdResponse

Documentation

getEventsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe String	expand: Specifies which fields in the response should be expanded.
-> String	id \| Constraints: Maximum length of 5000
-> GetEventsIdRequestBody	The request body to send
-> m (Either HttpException (Response GetEventsIdResponse))	Monad containing the result of the operation

GET /v1/events/{id}

<p>Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.</p>

getEventsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetEventsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/events/{id}

The same as getEventsId but returns the raw ByteString

getEventsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetEventsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetEventsIdResponse)) Source #

GET /v1/events/{id}

Monadic version of getEventsId (use with runWithConfiguration)

getEventsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetEventsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/events/{id}

Monadic version of getEventsIdRaw (use with runWithConfiguration)

data GetEventsIdRequestBody Source #

Defines the data type for the schema getEventsIdRequestBody

Constructors

GetEventsIdRequestBody

Instances

Eq GetEventsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetEventsId Methods (==) :: GetEventsIdRequestBody -> GetEventsIdRequestBody -> Bool # (/=) :: GetEventsIdRequestBody -> GetEventsIdRequestBody -> Bool #
Show GetEventsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetEventsId Methods showsPrec :: Int -> GetEventsIdRequestBody -> ShowS # show :: GetEventsIdRequestBody -> String # showList :: [GetEventsIdRequestBody] -> ShowS #
ToJSON GetEventsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetEventsId Methods toJSON :: GetEventsIdRequestBody -> Value # toEncoding :: GetEventsIdRequestBody -> Encoding # toJSONList :: [GetEventsIdRequestBody] -> Value # toEncodingList :: [GetEventsIdRequestBody] -> Encoding #
FromJSON GetEventsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetEventsId Methods parseJSON :: Value -> Parser GetEventsIdRequestBody # parseJSONList :: Value -> Parser [GetEventsIdRequestBody] #

data GetEventsIdResponse Source #

Represents a response of the operation getEventsId.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetEventsIdResponseError is used.

Constructors

GetEventsIdResponseError String	Means either no matching case available or a parse error
GetEventsIdResponse200 Event	Successful response.
GetEventsIdResponseDefault Error	Error response.

Instances

Eq GetEventsIdResponse Source #
Instance details Defined in StripeAPI.Operations.GetEventsId Methods (==) :: GetEventsIdResponse -> GetEventsIdResponse -> Bool # (/=) :: GetEventsIdResponse -> GetEventsIdResponse -> Bool #
Show GetEventsIdResponse Source #
Instance details Defined in StripeAPI.Operations.GetEventsId Methods showsPrec :: Int -> GetEventsIdResponse -> ShowS # show :: GetEventsIdResponse -> String # showList :: [GetEventsIdResponse] -> ShowS #