Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeleteProductsId

Description

Contains the different functions to run the operation deleteProductsId

Synopsis

deleteProductsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> DeleteProductsIdRequestBody -> m (Either HttpException (Response DeleteProductsIdResponse))
deleteProductsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> DeleteProductsIdRequestBody -> m (Either HttpException (Response ByteString))
deleteProductsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteProductsIdResponse))
deleteProductsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data DeleteProductsIdRequestBody = DeleteProductsIdRequestBody {
}
data DeleteProductsIdResponse

Documentation

deleteProductsId Source #

Arguments

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

DELETE /v1/products/{id}

<p>Delete a product. Deleting a product with type=<code>good</code> is only possible if it has no SKUs associated with it. Deleting a product with type=<code>service</code> is only possible if it has no plans associated with it.</p>

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

DELETE /v1/products/{id}

The same as deleteProductsId but returns the raw ByteString

deleteProductsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteProductsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteProductsIdResponse)) Source #

DELETE /v1/products/{id}

Monadic version of deleteProductsId (use with runWithConfiguration)

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

DELETE /v1/products/{id}

Monadic version of deleteProductsIdRaw (use with runWithConfiguration)

data DeleteProductsIdRequestBody Source #

Defines the data type for the schema deleteProductsIdRequestBody

Constructors

DeleteProductsIdRequestBody

Instances

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

data DeleteProductsIdResponse Source #

Represents a response of the operation deleteProductsId.

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

Constructors

DeleteProductsIdResponseError String	Means either no matching case available or a parse error
DeleteProductsIdResponse200 DeletedProduct	Successful response.
DeleteProductsIdResponseDefault Error	Error response.

Instances

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