| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetBitcoinTransactions
Description
Contains the different functions to run the operation getBitcoinTransactions
Synopsis
- getBitcoinTransactions :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> m (Either HttpException (Response GetBitcoinTransactionsResponse))
- getBitcoinTransactionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> m (Either HttpException (Response ByteString))
- getBitcoinTransactionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBitcoinTransactionsResponse))
- getBitcoinTransactionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetBitcoinTransactionsRequestBody = GetBitcoinTransactionsRequestBody {
- data GetBitcoinTransactionsResponse
- data GetBitcoinTransactionsResponseBody200 = GetBitcoinTransactionsResponseBody200 {}
- data GetBitcoinTransactionsResponseBody200Object'
Documentation
getBitcoinTransactions Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | customer: Only return transactions for the customer specified by this customer ID. | Constraints: Maximum length of 5000 |
| -> Maybe String | 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 String | expand: Specifies which fields in the response should be expanded. |
| -> 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 String | receiver | Constraints: Maximum length of 5000 |
| -> Maybe String | 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 |
| -> GetBitcoinTransactionsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetBitcoinTransactionsResponse)) | Monad containing the result of the operation |
GET /v1/bitcoin/transactions
<p>List bitcoin transacitons for a given receiver.</p>
getBitcoinTransactionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/bitcoin/transactions
The same as getBitcoinTransactions but returns the raw ByteString
getBitcoinTransactionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBitcoinTransactionsResponse)) Source #
GET /v1/bitcoin/transactions
Monadic version of getBitcoinTransactions (use with runWithConfiguration)
getBitcoinTransactionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetBitcoinTransactionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/bitcoin/transactions
Monadic version of getBitcoinTransactionsRaw (use with runWithConfiguration)
data GetBitcoinTransactionsRequestBody Source #
Defines the data type for the schema getBitcoinTransactionsRequestBody
Constructors
| GetBitcoinTransactionsRequestBody | |
Instances
data GetBitcoinTransactionsResponse Source #
Represents a response of the operation getBitcoinTransactions.
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), GetBitcoinTransactionsResponseError is used.
Constructors
| GetBitcoinTransactionsResponseError String | Means either no matching case available or a parse error |
| GetBitcoinTransactionsResponse200 GetBitcoinTransactionsResponseBody200 | Successful response. |
| GetBitcoinTransactionsResponseDefault Error | Error response. |
Instances
data GetBitcoinTransactionsResponseBody200 Source #
Defines the data type for the schema GetBitcoinTransactionsResponseBody200
Constructors
| GetBitcoinTransactionsResponseBody200 | |
Fields
| |
Instances
data GetBitcoinTransactionsResponseBody200Object' Source #
Defines the enum schema GetBitcoinTransactionsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetBitcoinTransactionsResponseBody200Object'EnumOther Value | |
| GetBitcoinTransactionsResponseBody200Object'EnumTyped String | |
| GetBitcoinTransactionsResponseBody200Object'EnumStringList |