| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetBitcoinReceivers
Description
Contains the different functions to run the operation getBitcoinReceivers
Synopsis
- getBitcoinReceivers :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> m (Either HttpException (Response GetBitcoinReceiversResponse))
- getBitcoinReceiversRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> m (Either HttpException (Response ByteString))
- getBitcoinReceiversM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBitcoinReceiversResponse))
- getBitcoinReceiversRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetBitcoinReceiversRequestBody = GetBitcoinReceiversRequestBody {
- data GetBitcoinReceiversResponse
- data GetBitcoinReceiversResponseBody200 = GetBitcoinReceiversResponseBody200 {}
- data GetBitcoinReceiversResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe Bool | active: Filter for active receivers. |
| -> Maybe Text | ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000 |
| -> Maybe Text | expand: Specifies which fields in the response should be expanded. |
| -> Maybe Bool | filled: Filter for filled receivers. |
| -> Maybe Integer | limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| -> Maybe Text | starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000 |
| -> Maybe Bool | uncaptured_funds: Filter for receivers with uncaptured funds. |
| -> Maybe GetBitcoinReceiversRequestBody | The request body to send |
| -> m (Either HttpException (Response GetBitcoinReceiversResponse)) | Monad containing the result of the operation |
GET /v1/bitcoin/receivers
<p>Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.</p>
getBitcoinReceiversRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/bitcoin/receivers
The same as getBitcoinReceivers but returns the raw ByteString
getBitcoinReceiversM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBitcoinReceiversResponse)) Source #
GET /v1/bitcoin/receivers
Monadic version of getBitcoinReceivers (use with runWithConfiguration)
getBitcoinReceiversRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe GetBitcoinReceiversRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/bitcoin/receivers
Monadic version of getBitcoinReceiversRaw (use with runWithConfiguration)
data GetBitcoinReceiversRequestBody Source #
Defines the data type for the schema getBitcoinReceiversRequestBody
Constructors
| GetBitcoinReceiversRequestBody | |
Instances
data GetBitcoinReceiversResponse Source #
Represents a response of the operation getBitcoinReceivers.
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), GetBitcoinReceiversResponseError is used.
Constructors
| GetBitcoinReceiversResponseError String | Means either no matching case available or a parse error |
| GetBitcoinReceiversResponse200 GetBitcoinReceiversResponseBody200 | Successful response. |
| GetBitcoinReceiversResponseDefault Error | Error response. |
Instances
| Eq GetBitcoinReceiversResponse Source # | |
Defined in StripeAPI.Operations.GetBitcoinReceivers Methods (==) :: GetBitcoinReceiversResponse -> GetBitcoinReceiversResponse -> Bool # (/=) :: GetBitcoinReceiversResponse -> GetBitcoinReceiversResponse -> Bool # | |
| Show GetBitcoinReceiversResponse Source # | |
Defined in StripeAPI.Operations.GetBitcoinReceivers Methods showsPrec :: Int -> GetBitcoinReceiversResponse -> ShowS # show :: GetBitcoinReceiversResponse -> String # showList :: [GetBitcoinReceiversResponse] -> ShowS # | |
data GetBitcoinReceiversResponseBody200 Source #
Defines the data type for the schema GetBitcoinReceiversResponseBody200
Constructors
| GetBitcoinReceiversResponseBody200 | |
Fields
| |
Instances
data GetBitcoinReceiversResponseBody200Object' Source #
Defines the enum schema GetBitcoinReceiversResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetBitcoinReceiversResponseBody200Object'EnumOther Value | |
| GetBitcoinReceiversResponseBody200Object'EnumTyped Text | |
| GetBitcoinReceiversResponseBody200Object'EnumStringList |