Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostAccountLoginLinks

Description

Contains the different functions to run the operation postAccountLoginLinks

Synopsis

postAccountLoginLinks :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostAccountLoginLinksRequestBody -> m (Either HttpException (Response PostAccountLoginLinksResponse))
postAccountLoginLinksRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostAccountLoginLinksRequestBody -> m (Either HttpException (Response ByteString))
postAccountLoginLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLoginLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountLoginLinksResponse))
postAccountLoginLinksRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLoginLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostAccountLoginLinksRequestBody = PostAccountLoginLinksRequestBody {
}
data PostAccountLoginLinksResponse

Documentation

postAccountLoginLinks Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostAccountLoginLinksRequestBody	The request body to send
-> m (Either HttpException (Response PostAccountLoginLinksResponse))	Monad containing the result of the operation

POST /v1/account/login_links

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for <a href="/docs/connect/express-accounts">Express accounts</a> connected to your platform.

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

POST /v1/account/login_links

The same as postAccountLoginLinks but returns the raw ByteString

postAccountLoginLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLoginLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountLoginLinksResponse)) Source #

POST /v1/account/login_links

Monadic version of postAccountLoginLinks (use with runWithConfiguration)

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

POST /v1/account/login_links

Monadic version of postAccountLoginLinksRaw (use with runWithConfiguration)

data PostAccountLoginLinksRequestBody Source #

Defines the data type for the schema postAccountLoginLinksRequestBody

Constructors

PostAccountLoginLinksRequestBody
Fields postAccountLoginLinksRequestBodyAccount :: Text account Constraints: Maximum length of 5000 postAccountLoginLinksRequestBodyExpand :: Maybe ([] Text) expand: Specifies which fields in the response should be expanded. postAccountLoginLinksRequestBodyRedirectUrl :: Maybe Text redirect_url: Where to redirect the user after they log out of their dashboard.

Instances

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

data PostAccountLoginLinksResponse Source #

Represents a response of the operation postAccountLoginLinks.

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

Constructors

PostAccountLoginLinksResponseError String	Means either no matching case available or a parse error
PostAccountLoginLinksResponse200 LoginLink	Successful response.
PostAccountLoginLinksResponseDefault Error	Error response.

Instances

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