Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.DeleteEphemeralKeysKey

Description

Contains the different functions to run the operation deleteEphemeralKeysKey

Synopsis

deleteEphemeralKeysKey :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> DeleteEphemeralKeysKeyRequestBody -> m (Either HttpException (Response DeleteEphemeralKeysKeyResponse))
deleteEphemeralKeysKeyRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> DeleteEphemeralKeysKeyRequestBody -> m (Either HttpException (Response ByteString))
deleteEphemeralKeysKeyM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteEphemeralKeysKeyRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteEphemeralKeysKeyResponse))
deleteEphemeralKeysKeyRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteEphemeralKeysKeyRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data DeleteEphemeralKeysKeyRequestBody = DeleteEphemeralKeysKeyRequestBody {
- deleteEphemeralKeysKeyRequestBodyExpand :: Maybe ([] String)
}
data DeleteEphemeralKeysKeyResponse

Documentation

deleteEphemeralKeysKey Source #

Arguments

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

DELETE /v1/ephemeral_keys/{key}

<p>Invalidates a short-lived API key for a given resource.</p>

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

DELETE /v1/ephemeral_keys/{key}

The same as deleteEphemeralKeysKey but returns the raw ByteString

deleteEphemeralKeysKeyM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> DeleteEphemeralKeysKeyRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response DeleteEphemeralKeysKeyResponse)) Source #

DELETE /v1/ephemeral_keys/{key}

Monadic version of deleteEphemeralKeysKey (use with runWithConfiguration)

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

DELETE /v1/ephemeral_keys/{key}

Monadic version of deleteEphemeralKeysKeyRaw (use with runWithConfiguration)

data DeleteEphemeralKeysKeyRequestBody Source #

Defines the data type for the schema deleteEphemeralKeysKeyRequestBody

Constructors

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

Instances

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

data DeleteEphemeralKeysKeyResponse Source #

Represents a response of the operation deleteEphemeralKeysKey.

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

Constructors

DeleteEphemeralKeysKeyResponseError String	Means either no matching case available or a parse error
DeleteEphemeralKeysKeyResponse200 EphemeralKey	Successful response.
DeleteEphemeralKeysKeyResponseDefault Error	Error response.

Instances

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