Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCreditNotesId

Description

Contains the different functions to run the operation getCreditNotesId

Synopsis

getCreditNotesId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetCreditNotesIdRequestBody -> m (Either HttpException (Response GetCreditNotesIdResponse))
getCreditNotesIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetCreditNotesIdRequestBody -> m (Either HttpException (Response ByteString))
getCreditNotesIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetCreditNotesIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesIdResponse))
getCreditNotesIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetCreditNotesIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetCreditNotesIdRequestBody = GetCreditNotesIdRequestBody {
}
data GetCreditNotesIdResponse

Documentation

getCreditNotesId 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
-> GetCreditNotesIdRequestBody	The request body to send
-> m (Either HttpException (Response GetCreditNotesIdResponse))	Monad containing the result of the operation

GET /v1/credit_notes/{id}

<p>Retrieves the credit note object with the given identifier.</p>

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

GET /v1/credit_notes/{id}

The same as getCreditNotesId but returns the raw ByteString

getCreditNotesIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetCreditNotesIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesIdResponse)) Source #

GET /v1/credit_notes/{id}

Monadic version of getCreditNotesId (use with runWithConfiguration)

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

GET /v1/credit_notes/{id}

Monadic version of getCreditNotesIdRaw (use with runWithConfiguration)

data GetCreditNotesIdRequestBody Source #

Defines the data type for the schema getCreditNotesIdRequestBody

Constructors

GetCreditNotesIdRequestBody

Instances

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

data GetCreditNotesIdResponse Source #

Represents a response of the operation getCreditNotesId.

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), GetCreditNotesIdResponseError is used.

Constructors

GetCreditNotesIdResponseError String	Means either no matching case available or a parse error
GetCreditNotesIdResponse200 CreditNote	Successful response.
GetCreditNotesIdResponseDefault Error	Error response.

Instances

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