Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostCreditNotesIdVoid

Description

Contains the different functions to run the operation postCreditNotesIdVoid

Synopsis

postCreditNotesIdVoid :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostCreditNotesIdVoidRequestBody -> m (Either HttpException (Response PostCreditNotesIdVoidResponse))
postCreditNotesIdVoidRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostCreditNotesIdVoidRequestBody -> m (Either HttpException (Response ByteString))
postCreditNotesIdVoidM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostCreditNotesIdVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCreditNotesIdVoidResponse))
postCreditNotesIdVoidRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostCreditNotesIdVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostCreditNotesIdVoidRequestBody = PostCreditNotesIdVoidRequestBody {
- postCreditNotesIdVoidRequestBodyExpand :: Maybe ([] String)
}
data PostCreditNotesIdVoidResponse

Documentation

postCreditNotesIdVoid Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> String	id \| Constraints: Maximum length of 5000
-> PostCreditNotesIdVoidRequestBody	The request body to send
-> m (Either HttpException (Response PostCreditNotesIdVoidResponse))	Monad containing the result of the operation

POST /v1/credit_notes/{id}/void

<p>Marks a credit note as void. Learn more about <a href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.</p>

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

POST /v1/credit_notes/{id}/void

The same as postCreditNotesIdVoid but returns the raw ByteString

postCreditNotesIdVoidM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostCreditNotesIdVoidRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCreditNotesIdVoidResponse)) Source #

POST /v1/credit_notes/{id}/void

Monadic version of postCreditNotesIdVoid (use with runWithConfiguration)

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

POST /v1/credit_notes/{id}/void

Monadic version of postCreditNotesIdVoidRaw (use with runWithConfiguration)

data PostCreditNotesIdVoidRequestBody Source #

Defines the data type for the schema postCreditNotesIdVoidRequestBody

Constructors

PostCreditNotesIdVoidRequestBody
Fields postCreditNotesIdVoidRequestBodyExpand :: Maybe ([] String) expand: Specifies which fields in the response should be expanded.

Instances

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

data PostCreditNotesIdVoidResponse Source #

Represents a response of the operation postCreditNotesIdVoid.

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

Constructors

PostCreditNotesIdVoidResponseError String	Means either no matching case available or a parse error
PostCreditNotesIdVoidResponse200 CreditNote	Successful response.
PostCreditNotesIdVoidResponseDefault Error	Error response.

Instances

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