Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetRadarValueLists

Description

Contains the different functions to run the operation getRadarValueLists

Synopsis

getRadarValueLists :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> m (Either HttpException (Response GetRadarValueListsResponse))
getRadarValueListsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> m (Either HttpException (Response ByteString))
getRadarValueListsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRadarValueListsResponse))
getRadarValueListsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetRadarValueListsRequestBody = GetRadarValueListsRequestBody {
}
data GetRadarValueListsResponse
data GetRadarValueListsResponseBody200 = GetRadarValueListsResponseBody200 {
}
data GetRadarValueListsResponseBody200Object'

Documentation

getRadarValueLists Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe Text	alias: The alias used to reference the value list when writing rules. \| Constraints: Maximum length of 100
-> Maybe Text	contains: A value contained within a value list - returns all value lists containing this value. \| Constraints: Maximum length of 800
-> 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 GetRadarValueListsRequestBody	The request body to send
-> m (Either HttpException (Response GetRadarValueListsResponse))	Monad containing the result of the operation

GET /v1/radar/value_lists

<p>Returns a list of <code>ValueList</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

getRadarValueListsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/radar/value_lists

The same as getRadarValueLists but returns the raw ByteString

getRadarValueListsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRadarValueListsResponse)) Source #

GET /v1/radar/value_lists

Monadic version of getRadarValueLists (use with runWithConfiguration)

getRadarValueListsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetRadarValueListsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/radar/value_lists

Monadic version of getRadarValueListsRaw (use with runWithConfiguration)

data GetRadarValueListsRequestBody Source #

Defines the data type for the schema getRadarValueListsRequestBody

Constructors

GetRadarValueListsRequestBody

Instances

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

data GetRadarValueListsResponse Source #

Represents a response of the operation getRadarValueLists.

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

Constructors

GetRadarValueListsResponseError String	Means either no matching case available or a parse error
GetRadarValueListsResponse200 GetRadarValueListsResponseBody200	Successful response.
GetRadarValueListsResponseDefault Error	Error response.

Instances

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

data GetRadarValueListsResponseBody200 Source #

Defines the data type for the schema GetRadarValueListsResponseBody200

Constructors

GetRadarValueListsResponseBody200

Fields

getRadarValueListsResponseBody200Data :: [] Radar'valueList
data
getRadarValueListsResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getRadarValueListsResponseBody200Object :: GetRadarValueListsResponseBody200Object'
object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
getRadarValueListsResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000
- Must match pattern '^/v1/radar/value_lists'

Instances

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

data GetRadarValueListsResponseBody200Object' Source #

Defines the enum schema GetRadarValueListsResponseBody200Object'

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

Constructors

GetRadarValueListsResponseBody200Object'EnumOther Value
GetRadarValueListsResponseBody200Object'EnumTyped Text
GetRadarValueListsResponseBody200Object'EnumStringList

Instances

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