Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeleteInvoicesInvoice

Description

Contains the different functions to run the operation deleteInvoicesInvoice

Synopsis

deleteInvoicesInvoice :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> DeleteInvoicesInvoiceRequestBody -> m (Either HttpException (Response DeleteInvoicesInvoiceResponse))
deleteInvoicesInvoiceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> DeleteInvoicesInvoiceRequestBody -> m (Either HttpException (Response ByteString))
deleteInvoicesInvoiceM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteInvoicesInvoiceResponse))
deleteInvoicesInvoiceRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data DeleteInvoicesInvoiceRequestBody = DeleteInvoicesInvoiceRequestBody {
}
data DeleteInvoicesInvoiceResponse

Documentation

deleteInvoicesInvoice Source #

Arguments

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

DELETE /v1/invoices/{invoice}

<p>Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized, it must be <a href="#void_invoice">voided</a>.</p>

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

DELETE /v1/invoices/{invoice}

The same as deleteInvoicesInvoice but returns the raw ByteString

deleteInvoicesInvoiceM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteInvoicesInvoiceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteInvoicesInvoiceResponse)) Source #

DELETE /v1/invoices/{invoice}

Monadic version of deleteInvoicesInvoice (use with runWithConfiguration)

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

DELETE /v1/invoices/{invoice}

Monadic version of deleteInvoicesInvoiceRaw (use with runWithConfiguration)

data DeleteInvoicesInvoiceRequestBody Source #

Defines the data type for the schema deleteInvoicesInvoiceRequestBody

Constructors

DeleteInvoicesInvoiceRequestBody

Instances

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

data DeleteInvoicesInvoiceResponse Source #

Represents a response of the operation deleteInvoicesInvoice.

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

Constructors

DeleteInvoicesInvoiceResponseError String	Means either no matching case available or a parse error
DeleteInvoicesInvoiceResponse200 DeletedInvoice	Successful response.
DeleteInvoicesInvoiceResponseDefault Error	Error response.

Instances

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