StripeAPI.Operations.GetEventsId

Contains the different functions to run the operation getEventsId

Documentation

getEventsId

Arguments

:: forall m. MonadHTTP m

=> GetEventsIdParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetEventsIdResponse)

Monadic computation which returns 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>

data GetEventsIdParameters

Defines the object schema located at paths./v1/events/{id}.GET.parameters in the specification.

Constructors

GetEventsIdParameters

Fields

• getEventsIdParametersPathId :: Text

  pathId: Represents the parameter named 'id'

  Constraints:

  • Maximum length of 5000
• getEventsIdParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

Instances

Eq GetEventsIdParameters

Defined in StripeAPI.Operations.GetEventsId

Methods

(==) :: GetEventsIdParameters -> GetEventsIdParameters -> Bool

(/=) :: GetEventsIdParameters -> GetEventsIdParameters -> Bool

Show GetEventsIdParameters

Defined in StripeAPI.Operations.GetEventsId

Methods

showsPrec :: Int -> GetEventsIdParameters -> ShowS

show :: GetEventsIdParameters -> String

showList :: [GetEventsIdParameters] -> ShowS

ToJSON GetEventsIdParameters

Defined in StripeAPI.Operations.GetEventsId

Methods

toJSON :: GetEventsIdParameters -> Value

toEncoding :: GetEventsIdParameters -> Encoding

toJSONList :: [GetEventsIdParameters] -> Value

toEncodingList :: [GetEventsIdParameters] -> Encoding

FromJSON GetEventsIdParameters

Defined in StripeAPI.Operations.GetEventsId

Methods

parseJSON :: Value -> Parser GetEventsIdParameters

parseJSONList :: Value -> Parser [GetEventsIdParameters]

mkGetEventsIdParameters

Arguments

:: Text

getEventsIdParametersPathId

-> GetEventsIdParameters

Create a new GetEventsIdParameters with all required fields.

data GetEventsIdResponse

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

Defined in StripeAPI.Operations.GetEventsId

Methods

(==) :: GetEventsIdResponse -> GetEventsIdResponse -> Bool

(/=) :: GetEventsIdResponse -> GetEventsIdResponse -> Bool

Show GetEventsIdResponse

Defined in StripeAPI.Operations.GetEventsId

Methods

showsPrec :: Int -> GetEventsIdResponse -> ShowS

show :: GetEventsIdResponse -> String

showList :: [GetEventsIdResponse] -> ShowS