StripeAPI.Operations.PutAccountLogout

Contains the different functions to run the operation putAccountLogout

Documentation

putAccountLogout

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> PutAccountLogoutRequestBody

The request body to send

-> m (Either HttpException (Response PutAccountLogoutResponse))

Monad containing the result of the operation

PUT /v1/account/logout

<p>Invalidates all sessions for a light account, for a platform to use during platform logout.</p>

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

putAccountLogoutRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PutAccountLogoutRequestBody -> m (Either HttpException (Response ByteString))

PUT /v1/account/logout

The same as putAccountLogout but returns the raw ByteString

putAccountLogoutM :: forall m s. (MonadHTTP m, SecurityScheme s) => PutAccountLogoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PutAccountLogoutResponse))

PUT /v1/account/logout

Monadic version of putAccountLogout (use with runWithConfiguration)

putAccountLogoutRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PutAccountLogoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

PUT /v1/account/logout

Monadic version of putAccountLogoutRaw (use with runWithConfiguration)

data PutAccountLogoutRequestBody

Defines the data type for the schema putAccountLogoutRequestBody

Constructors

PutAccountLogoutRequestBody

Fields

• putAccountLogoutRequestBodyAccount :: Text

  account

  Constraints:

  • Maximum length of 5000
• putAccountLogoutRequestBodyExpand :: Maybe ([] Text)

  expand: Specifies which fields in the response should be expanded.

Instances

Eq PutAccountLogoutRequestBody

Defined in StripeAPI.Operations.PutAccountLogout

Methods

(==) :: PutAccountLogoutRequestBody -> PutAccountLogoutRequestBody -> Bool

(/=) :: PutAccountLogoutRequestBody -> PutAccountLogoutRequestBody -> Bool

Show PutAccountLogoutRequestBody

Defined in StripeAPI.Operations.PutAccountLogout

Methods

showsPrec :: Int -> PutAccountLogoutRequestBody -> ShowS

show :: PutAccountLogoutRequestBody -> String

showList :: [PutAccountLogoutRequestBody] -> ShowS

ToJSON PutAccountLogoutRequestBody

Defined in StripeAPI.Operations.PutAccountLogout

Methods

toJSON :: PutAccountLogoutRequestBody -> Value

toEncoding :: PutAccountLogoutRequestBody -> Encoding

toJSONList :: [PutAccountLogoutRequestBody] -> Value

toEncodingList :: [PutAccountLogoutRequestBody] -> Encoding

FromJSON PutAccountLogoutRequestBody

Defined in StripeAPI.Operations.PutAccountLogout

Methods

parseJSON :: Value -> Parser PutAccountLogoutRequestBody

parseJSONList :: Value -> Parser [PutAccountLogoutRequestBody]

data PutAccountLogoutResponse

Represents a response of the operation putAccountLogout.

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

Constructors

PutAccountLogoutResponseError String

Means either no matching case available or a parse error

PutAccountLogoutResponse200 LightAccountLogout

Successful response.

PutAccountLogoutResponseDefault Error

Error response.

Instances

Eq PutAccountLogoutResponse

Defined in StripeAPI.Operations.PutAccountLogout

Methods

(==) :: PutAccountLogoutResponse -> PutAccountLogoutResponse -> Bool

(/=) :: PutAccountLogoutResponse -> PutAccountLogoutResponse -> Bool

Show PutAccountLogoutResponse

Defined in StripeAPI.Operations.PutAccountLogout

Methods

showsPrec :: Int -> PutAccountLogoutResponse -> ShowS

show :: PutAccountLogoutResponse -> String

showList :: [PutAccountLogoutResponse] -> ShowS