| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetBalance
Description
Contains the different functions to run the operation getBalance
Synopsis
- getBalance :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> GetBalanceRequestBody -> m (Either HttpException (Response GetBalanceResponse))
- getBalanceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> GetBalanceRequestBody -> m (Either HttpException (Response ByteString))
- getBalanceM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> GetBalanceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBalanceResponse))
- getBalanceRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> GetBalanceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetBalanceRequestBody = GetBalanceRequestBody {
- data GetBalanceResponse
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | expand: Specifies which fields in the response should be expanded. |
| -> GetBalanceRequestBody | The request body to send |
| -> m (Either HttpException (Response GetBalanceResponse)) | Monad containing the result of the operation |
GET /v1/balance
<p>Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see <a href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative balances</a>.</p>
getBalanceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> GetBalanceRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/balance
The same as getBalance but returns the raw ByteString
getBalanceM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> GetBalanceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBalanceResponse)) Source #
GET /v1/balance
Monadic version of getBalance (use with runWithConfiguration)
getBalanceRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> GetBalanceRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/balance
Monadic version of getBalanceRaw (use with runWithConfiguration)
data GetBalanceRequestBody Source #
Defines the data type for the schema getBalanceRequestBody
Constructors
| GetBalanceRequestBody | |
Instances
| Eq GetBalanceRequestBody Source # | |
Defined in StripeAPI.Operations.GetBalance Methods (==) :: GetBalanceRequestBody -> GetBalanceRequestBody -> Bool # (/=) :: GetBalanceRequestBody -> GetBalanceRequestBody -> Bool # | |
| Show GetBalanceRequestBody Source # | |
Defined in StripeAPI.Operations.GetBalance Methods showsPrec :: Int -> GetBalanceRequestBody -> ShowS # show :: GetBalanceRequestBody -> String # showList :: [GetBalanceRequestBody] -> ShowS # | |
| ToJSON GetBalanceRequestBody Source # | |
Defined in StripeAPI.Operations.GetBalance Methods toJSON :: GetBalanceRequestBody -> Value # toEncoding :: GetBalanceRequestBody -> Encoding # toJSONList :: [GetBalanceRequestBody] -> Value # toEncodingList :: [GetBalanceRequestBody] -> Encoding # | |
| FromJSON GetBalanceRequestBody Source # | |
Defined in StripeAPI.Operations.GetBalance Methods parseJSON :: Value -> Parser GetBalanceRequestBody # parseJSONList :: Value -> Parser [GetBalanceRequestBody] # | |
data GetBalanceResponse Source #
Represents a response of the operation getBalance.
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), GetBalanceResponseError is used.
Constructors
| GetBalanceResponseError String | Means either no matching case available or a parse error |
| GetBalanceResponse200 Balance | Successful response. |
| GetBalanceResponseDefault Error | Error response. |
Instances
| Eq GetBalanceResponse Source # | |
Defined in StripeAPI.Operations.GetBalance Methods (==) :: GetBalanceResponse -> GetBalanceResponse -> Bool # (/=) :: GetBalanceResponse -> GetBalanceResponse -> Bool # | |
| Show GetBalanceResponse Source # | |
Defined in StripeAPI.Operations.GetBalance Methods showsPrec :: Int -> GetBalanceResponse -> ShowS # show :: GetBalanceResponse -> String # showList :: [GetBalanceResponse] -> ShowS # | |