StripeAPI.Operations.GetBitcoinReceivers

Contains the different functions to run the operation getBitcoinReceivers

Documentation

getBitcoinReceivers

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Bool

active: Filter for active receivers.

-> 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 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 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

-> Maybe Bool

uncaptured_funds: Filter for receivers with uncaptured funds.

-> 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 String -> Maybe String -> Maybe Bool -> Maybe Integer -> Maybe String -> Maybe Bool -> GetBitcoinReceiversRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/bitcoin/receivers

The same as getBitcoinReceivers but returns the raw ByteString

getBitcoinReceiversM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Integer -> Maybe String -> Maybe Bool -> GetBitcoinReceiversRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetBitcoinReceiversResponse))

GET /v1/bitcoin/receivers

Monadic version of getBitcoinReceivers (use with runWithConfiguration)

getBitcoinReceiversRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Integer -> Maybe String -> Maybe Bool -> GetBitcoinReceiversRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/bitcoin/receivers

Monadic version of getBitcoinReceiversRaw (use with runWithConfiguration)

data GetBitcoinReceiversRequestBody

Defines the data type for the schema getBitcoinReceiversRequestBody

Constructors

GetBitcoinReceiversRequestBody

Instances

Eq GetBitcoinReceiversRequestBody

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

(==) :: GetBitcoinReceiversRequestBody -> GetBitcoinReceiversRequestBody -> Bool

(/=) :: GetBitcoinReceiversRequestBody -> GetBitcoinReceiversRequestBody -> Bool

Show GetBitcoinReceiversRequestBody

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

showsPrec :: Int -> GetBitcoinReceiversRequestBody -> ShowS

show :: GetBitcoinReceiversRequestBody -> String

showList :: [GetBitcoinReceiversRequestBody] -> ShowS

ToJSON GetBitcoinReceiversRequestBody

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

toJSON :: GetBitcoinReceiversRequestBody -> Value

toEncoding :: GetBitcoinReceiversRequestBody -> Encoding

toJSONList :: [GetBitcoinReceiversRequestBody] -> Value

toEncodingList :: [GetBitcoinReceiversRequestBody] -> Encoding

FromJSON GetBitcoinReceiversRequestBody

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

parseJSON :: Value -> Parser GetBitcoinReceiversRequestBody

parseJSONList :: Value -> Parser [GetBitcoinReceiversRequestBody]

data GetBitcoinReceiversResponse

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

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

(==) :: GetBitcoinReceiversResponse -> GetBitcoinReceiversResponse -> Bool

(/=) :: GetBitcoinReceiversResponse -> GetBitcoinReceiversResponse -> Bool

Show GetBitcoinReceiversResponse

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

showsPrec :: Int -> GetBitcoinReceiversResponse -> ShowS

show :: GetBitcoinReceiversResponse -> String

showList :: [GetBitcoinReceiversResponse] -> ShowS

data GetBitcoinReceiversResponseBody200

Defines the data type for the schema GetBitcoinReceiversResponseBody200

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.

• getBitcoinReceiversResponseBody200Object :: GetBitcoinReceiversResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getBitcoinReceiversResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/bitcoin/receivers'

Instances

Eq GetBitcoinReceiversResponseBody200

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

(==) :: GetBitcoinReceiversResponseBody200 -> GetBitcoinReceiversResponseBody200 -> Bool

(/=) :: GetBitcoinReceiversResponseBody200 -> GetBitcoinReceiversResponseBody200 -> Bool

Show GetBitcoinReceiversResponseBody200

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

showsPrec :: Int -> GetBitcoinReceiversResponseBody200 -> ShowS

show :: GetBitcoinReceiversResponseBody200 -> String

showList :: [GetBitcoinReceiversResponseBody200] -> ShowS

ToJSON GetBitcoinReceiversResponseBody200

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

toJSON :: GetBitcoinReceiversResponseBody200 -> Value

toEncoding :: GetBitcoinReceiversResponseBody200 -> Encoding

toJSONList :: [GetBitcoinReceiversResponseBody200] -> Value

toEncodingList :: [GetBitcoinReceiversResponseBody200] -> Encoding

FromJSON GetBitcoinReceiversResponseBody200

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

parseJSON :: Value -> Parser GetBitcoinReceiversResponseBody200

parseJSONList :: Value -> Parser [GetBitcoinReceiversResponseBody200]

data GetBitcoinReceiversResponseBody200Object'

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 String

GetBitcoinReceiversResponseBody200Object'EnumStringList

Instances

Eq GetBitcoinReceiversResponseBody200Object'

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

(==) :: GetBitcoinReceiversResponseBody200Object' -> GetBitcoinReceiversResponseBody200Object' -> Bool

(/=) :: GetBitcoinReceiversResponseBody200Object' -> GetBitcoinReceiversResponseBody200Object' -> Bool

Show GetBitcoinReceiversResponseBody200Object'

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

showsPrec :: Int -> GetBitcoinReceiversResponseBody200Object' -> ShowS

show :: GetBitcoinReceiversResponseBody200Object' -> String

showList :: [GetBitcoinReceiversResponseBody200Object'] -> ShowS

ToJSON GetBitcoinReceiversResponseBody200Object'

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

toJSON :: GetBitcoinReceiversResponseBody200Object' -> Value

toEncoding :: GetBitcoinReceiversResponseBody200Object' -> Encoding

toJSONList :: [GetBitcoinReceiversResponseBody200Object'] -> Value

toEncodingList :: [GetBitcoinReceiversResponseBody200Object'] -> Encoding

FromJSON GetBitcoinReceiversResponseBody200Object'

Defined in StripeAPI.Operations.GetBitcoinReceivers

Methods

parseJSON :: Value -> Parser GetBitcoinReceiversResponseBody200Object'

parseJSONList :: Value -> Parser [GetBitcoinReceiversResponseBody200Object']