Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PutAccountsAccountLogout

Description

Contains the different functions to run the operation putAccountsAccountLogout

Synopsis

putAccountsAccountLogout :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PutAccountsAccountLogoutRequestBody -> m (Either HttpException (Response PutAccountsAccountLogoutResponse))
putAccountsAccountLogoutRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PutAccountsAccountLogoutRequestBody -> m (Either HttpException (Response ByteString))
putAccountsAccountLogoutM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PutAccountsAccountLogoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PutAccountsAccountLogoutResponse))
putAccountsAccountLogoutRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PutAccountsAccountLogoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PutAccountsAccountLogoutRequestBody = PutAccountsAccountLogoutRequestBody {
- putAccountsAccountLogoutRequestBodyExpand :: Maybe ([] String)
}
data PutAccountsAccountLogoutResponse

Documentation

putAccountsAccountLogout Source #

Arguments

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

PUT /v1/accounts/{account}/logout

Invalidates all sessions for a light account, for a platform to use during platform logout.

You may only log out <a href="/docs/connect/express-accounts">Express accounts</a> connected to your platform.

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

PUT /v1/accounts/{account}/logout

The same as putAccountsAccountLogout but returns the raw ByteString

putAccountsAccountLogoutM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PutAccountsAccountLogoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PutAccountsAccountLogoutResponse)) Source #

PUT /v1/accounts/{account}/logout

Monadic version of putAccountsAccountLogout (use with runWithConfiguration)

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

PUT /v1/accounts/{account}/logout

Monadic version of putAccountsAccountLogoutRaw (use with runWithConfiguration)

data PutAccountsAccountLogoutRequestBody Source #

Defines the data type for the schema putAccountsAccountLogoutRequestBody

Constructors

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

Instances

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

data PutAccountsAccountLogoutResponse Source #

Represents a response of the operation putAccountsAccountLogout.

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

Constructors

PutAccountsAccountLogoutResponseError String	Means either no matching case available or a parse error
PutAccountsAccountLogoutResponse200 LightAccountLogout	Successful response.
PutAccountsAccountLogoutResponseDefault Error	Error response.

Instances

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