StripeAPI.Operations.GetRecipients

Contains the different functions to run the operation getRecipients

Documentation

getRecipients

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created

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

type | Constraints: Maximum length of 5000

-> Maybe Bool

verified: Only return recipients that are verified or unverified.

-> Maybe GetRecipientsRequestBody

The request body to send

-> m (Either HttpException (Response GetRecipientsResponse))

Monad containing the result of the operation

GET /v1/recipients

<p>Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.</p>

getRecipientsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe GetRecipientsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/recipients

The same as getRecipients but returns the raw ByteString

getRecipientsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe GetRecipientsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRecipientsResponse))

GET /v1/recipients

Monadic version of getRecipients (use with runWithConfiguration)

getRecipientsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe GetRecipientsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/recipients

Monadic version of getRecipientsRaw (use with runWithConfiguration)

data GetRecipientsRequestBody

Defines the data type for the schema getRecipientsRequestBody

Constructors

GetRecipientsRequestBody

Instances

Eq GetRecipientsRequestBody

Defined in StripeAPI.Operations.GetRecipients

Methods

(==) :: GetRecipientsRequestBody -> GetRecipientsRequestBody -> Bool

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

Show GetRecipientsRequestBody

Defined in StripeAPI.Operations.GetRecipients

Methods

showsPrec :: Int -> GetRecipientsRequestBody -> ShowS

show :: GetRecipientsRequestBody -> String

showList :: [GetRecipientsRequestBody] -> ShowS

ToJSON GetRecipientsRequestBody

Defined in StripeAPI.Operations.GetRecipients

Methods

toJSON :: GetRecipientsRequestBody -> Value

toEncoding :: GetRecipientsRequestBody -> Encoding

toJSONList :: [GetRecipientsRequestBody] -> Value

toEncodingList :: [GetRecipientsRequestBody] -> Encoding

FromJSON GetRecipientsRequestBody

Defined in StripeAPI.Operations.GetRecipients

Methods

parseJSON :: Value -> Parser GetRecipientsRequestBody

parseJSONList :: Value -> Parser [GetRecipientsRequestBody]

data GetRecipientsResponse

Represents a response of the operation getRecipients.

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), GetRecipientsResponseError is used.

Constructors

GetRecipientsResponseError String

Means either no matching case available or a parse error

GetRecipientsResponse200 GetRecipientsResponseBody200

Successful response.

GetRecipientsResponseDefault Error

Error response.

Instances

Eq GetRecipientsResponse

Defined in StripeAPI.Operations.GetRecipients

Methods

(==) :: GetRecipientsResponse -> GetRecipientsResponse -> Bool

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

Show GetRecipientsResponse

Defined in StripeAPI.Operations.GetRecipients

Methods

showsPrec :: Int -> GetRecipientsResponse -> ShowS

show :: GetRecipientsResponse -> String

showList :: [GetRecipientsResponse] -> ShowS

data GetRecipientsResponseBody200

Defines the data type for the schema GetRecipientsResponseBody200

Constructors

GetRecipientsResponseBody200

Fields

• getRecipientsResponseBody200Data :: [] Recipient

  data

• getRecipientsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getRecipientsResponseBody200Object :: GetRecipientsResponseBody200Object'

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

• getRecipientsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetRecipientsResponseBody200

Defined in StripeAPI.Operations.GetRecipients

Methods

(==) :: GetRecipientsResponseBody200 -> GetRecipientsResponseBody200 -> Bool

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

Show GetRecipientsResponseBody200

Defined in StripeAPI.Operations.GetRecipients

Methods

showsPrec :: Int -> GetRecipientsResponseBody200 -> ShowS

show :: GetRecipientsResponseBody200 -> String

showList :: [GetRecipientsResponseBody200] -> ShowS

ToJSON GetRecipientsResponseBody200

Defined in StripeAPI.Operations.GetRecipients

Methods

toJSON :: GetRecipientsResponseBody200 -> Value

toEncoding :: GetRecipientsResponseBody200 -> Encoding

toJSONList :: [GetRecipientsResponseBody200] -> Value

toEncodingList :: [GetRecipientsResponseBody200] -> Encoding

FromJSON GetRecipientsResponseBody200

Defined in StripeAPI.Operations.GetRecipients

Methods

parseJSON :: Value -> Parser GetRecipientsResponseBody200

parseJSONList :: Value -> Parser [GetRecipientsResponseBody200]

data GetRecipientsResponseBody200Object'

Defines the enum schema GetRecipientsResponseBody200Object'

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

Constructors

GetRecipientsResponseBody200Object'EnumOther Value

GetRecipientsResponseBody200Object'EnumTyped Text

GetRecipientsResponseBody200Object'EnumStringList

Instances

Eq GetRecipientsResponseBody200Object'

Defined in StripeAPI.Operations.GetRecipients

Methods

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

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

Show GetRecipientsResponseBody200Object'

Defined in StripeAPI.Operations.GetRecipients

Methods

showsPrec :: Int -> GetRecipientsResponseBody200Object' -> ShowS

show :: GetRecipientsResponseBody200Object' -> String

showList :: [GetRecipientsResponseBody200Object'] -> ShowS

ToJSON GetRecipientsResponseBody200Object'

Defined in StripeAPI.Operations.GetRecipients

Methods

toJSON :: GetRecipientsResponseBody200Object' -> Value

toEncoding :: GetRecipientsResponseBody200Object' -> Encoding

toJSONList :: [GetRecipientsResponseBody200Object'] -> Value

toEncodingList :: [GetRecipientsResponseBody200Object'] -> Encoding

FromJSON GetRecipientsResponseBody200Object'

Defined in StripeAPI.Operations.GetRecipients

Methods

parseJSON :: Value -> Parser GetRecipientsResponseBody200Object'

parseJSONList :: Value -> Parser [GetRecipientsResponseBody200Object']