Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeleteRecipientsId

Description

Contains the different functions to run the operation deleteRecipientsId

Synopsis

deleteRecipientsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeleteRecipientsIdRequestBody -> m (Either HttpException (Response DeleteRecipientsIdResponse))
deleteRecipientsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe DeleteRecipientsIdRequestBody -> m (Either HttpException (Response ByteString))
deleteRecipientsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteRecipientsIdResponse))
deleteRecipientsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data DeleteRecipientsIdRequestBody = DeleteRecipientsIdRequestBody {
}
data DeleteRecipientsIdResponse

Documentation

deleteRecipientsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	id \| Constraints: Maximum length of 5000
-> Maybe 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 -> Text -> Maybe DeleteRecipientsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

DELETE /v1/recipients/{id}

The same as deleteRecipientsId but returns the raw ByteString

deleteRecipientsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteRecipientsIdResponse)) Source #

DELETE /v1/recipients/{id}

Monadic version of deleteRecipientsId (use with runWithConfiguration)

deleteRecipientsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe DeleteRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

DELETE /v1/recipients/{id}

Monadic version of deleteRecipientsIdRaw (use with runWithConfiguration)

data DeleteRecipientsIdRequestBody Source #

Defines the data type for the schema deleteRecipientsIdRequestBody

Constructors

DeleteRecipientsIdRequestBody

Instances

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

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.

Instances

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