Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetBitcoinReceivers

Description

Contains the different functions to run the operation getBitcoinReceivers

Synopsis

getBitcoinReceivers :: forall m. MonadHTTP m => GetBitcoinReceiversParameters -> ClientT m (Response GetBitcoinReceiversResponse)
data GetBitcoinReceiversParameters = GetBitcoinReceiversParameters {
}
mkGetBitcoinReceiversParameters :: GetBitcoinReceiversParameters
data GetBitcoinReceiversResponse
data GetBitcoinReceiversResponseBody200 = GetBitcoinReceiversResponseBody200 {
}
mkGetBitcoinReceiversResponseBody200 :: [BitcoinReceiver] -> Bool -> Text -> GetBitcoinReceiversResponseBody200

Documentation

getBitcoinReceivers Source #

Arguments

:: forall m. MonadHTTP m
=> GetBitcoinReceiversParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetBitcoinReceiversResponse)	Monadic computation which returns 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>

data GetBitcoinReceiversParameters Source #

Defines the object schema located at paths./v1/bitcoin/receivers.GET.parameters in the specification.

Constructors

GetBitcoinReceiversParameters

Fields

getBitcoinReceiversParametersQueryActive :: Maybe Bool
queryActive: Represents the parameter named 'active'
Filter for active receivers.
getBitcoinReceiversParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named '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
getBitcoinReceiversParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getBitcoinReceiversParametersQueryFilled :: Maybe Bool
queryFilled: Represents the parameter named 'filled'
Filter for filled receivers.
getBitcoinReceiversParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getBitcoinReceiversParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named '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
getBitcoinReceiversParametersQueryUncapturedFunds :: Maybe Bool
queryUncaptured_funds: Represents the parameter named 'uncaptured_funds'
Filter for receivers with uncaptured funds.

Instances

Instances details

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

mkGetBitcoinReceiversParameters :: GetBitcoinReceiversParameters Source #

Create a new GetBitcoinReceiversParameters with all required fields.

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

Instances details

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

data GetBitcoinReceiversResponseBody200 Source #

Defines the object schema located at paths./v1/bitcoin/receivers.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetBitcoinReceiversResponseBody200
Fields getBitcoinReceiversResponseBody200Data :: [BitcoinReceiver] data getBitcoinReceiversResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getBitcoinReceiversResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/bitcoin/receivers'

Instances

Instances details

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

mkGetBitcoinReceiversResponseBody200 Source #

Arguments

:: [BitcoinReceiver]	`getBitcoinReceiversResponseBody200Data`
-> Bool	`getBitcoinReceiversResponseBody200HasMore`
-> Text	`getBitcoinReceiversResponseBody200Url`
-> GetBitcoinReceiversResponseBody200

Create a new GetBitcoinReceiversResponseBody200 with all required fields.