stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.DeleteRecipientsId

Description

Contains the different functions to run the operation deleteRecipientsId

Synopsis

Documentation

deleteRecipientsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> DeleteRecipientsIdRequestBody

The request body to send

-> m (Either HttpException (Response DeleteRecipientsIdResponse))

Monad containing the result of the operation

DELETE /v1/recipients/{id}

<p>Permanently deletes a recipient. It cannot be undone.</p>

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

DELETE /v1/recipients/{id}

The same as deleteRecipientsId but returns the raw ByteString

data DeleteRecipientsIdResponse Source #

Represents a response of the operation deleteRecipientsId.

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

Constructors

DeleteRecipientsIdResponseError String

Means either no matching case available or a parse error

DeleteRecipientsIdResponse200 DeletedRecipient

Successful response.

DeleteRecipientsIdResponseDefault Error

Error response.