Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetRadarValueListItems

Description

Contains the different functions to run the operation getRadarValueListItems

Synopsis

getRadarValueListItems :: forall m. MonadHTTP m => GetRadarValueListItemsParameters -> ClientT m (Response GetRadarValueListItemsResponse)
data GetRadarValueListItemsParameters = GetRadarValueListItemsParameters {
}
mkGetRadarValueListItemsParameters :: Text -> GetRadarValueListItemsParameters
data GetRadarValueListItemsParametersQueryCreated'OneOf1 = GetRadarValueListItemsParametersQueryCreated'OneOf1 {
}
mkGetRadarValueListItemsParametersQueryCreated'OneOf1 :: GetRadarValueListItemsParametersQueryCreated'OneOf1
data GetRadarValueListItemsParametersQueryCreated'Variants
- = GetRadarValueListItemsParametersQueryCreated'GetRadarValueListItemsParametersQueryCreated'OneOf1 GetRadarValueListItemsParametersQueryCreated'OneOf1
- | GetRadarValueListItemsParametersQueryCreated'Int Int
data GetRadarValueListItemsResponse
data GetRadarValueListItemsResponseBody200 = GetRadarValueListItemsResponseBody200 {
}
mkGetRadarValueListItemsResponseBody200 :: [Radar'valueListItem] -> Bool -> Text -> GetRadarValueListItemsResponseBody200

Documentation

getRadarValueListItems Source #

Arguments

:: forall m. MonadHTTP m
=> GetRadarValueListItemsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetRadarValueListItemsResponse)	Monadic computation which returns the result of the operation

GET /v1/radar/value_list_items

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

data GetRadarValueListItemsParameters Source #

Defines the object schema located at paths./v1/radar/value_list_items.GET.parameters in the specification.

Constructors

GetRadarValueListItemsParameters

Fields

getRadarValueListItemsParametersQueryCreated :: Maybe GetRadarValueListItemsParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
getRadarValueListItemsParametersQueryEndingBefore :: 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
getRadarValueListItemsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getRadarValueListItemsParametersQueryLimit :: 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.
getRadarValueListItemsParametersQueryStartingAfter :: 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
getRadarValueListItemsParametersQueryValue :: Maybe Text
queryValue: Represents the parameter named 'value'
Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
Constraints:
- Maximum length of 800
getRadarValueListItemsParametersQueryValueList :: Text
queryValue_list: Represents the parameter named 'value_list'
Identifier for the parent value list this item belongs to.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkGetRadarValueListItemsParameters Source #

Arguments

:: Text	`getRadarValueListItemsParametersQueryValueList`
-> GetRadarValueListItemsParameters

Create a new GetRadarValueListItemsParameters with all required fields.

data GetRadarValueListItemsParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/radar/value_list_items.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetRadarValueListItemsParametersQueryCreated'OneOf1
Fields getRadarValueListItemsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getRadarValueListItemsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getRadarValueListItemsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getRadarValueListItemsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetRadarValueListItemsParametersQueryCreated'OneOf1 :: GetRadarValueListItemsParametersQueryCreated'OneOf1 Source #

Create a new GetRadarValueListItemsParametersQueryCreated'OneOf1 with all required fields.

data GetRadarValueListItemsParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/radar/value_list_items.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetRadarValueListItemsParametersQueryCreated'GetRadarValueListItemsParametersQueryCreated'OneOf1 GetRadarValueListItemsParametersQueryCreated'OneOf1
GetRadarValueListItemsParametersQueryCreated'Int Int

Instances

Instances details

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

data GetRadarValueListItemsResponse Source #

Represents a response of the operation getRadarValueListItems.

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

Constructors

GetRadarValueListItemsResponseError String	Means either no matching case available or a parse error
GetRadarValueListItemsResponse200 GetRadarValueListItemsResponseBody200	Successful response.
GetRadarValueListItemsResponseDefault Error	Error response.

Instances

Instances details

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

data GetRadarValueListItemsResponseBody200 Source #

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

Constructors

GetRadarValueListItemsResponseBody200

Fields

getRadarValueListItemsResponseBody200Data :: [Radar'valueListItem]
data
getRadarValueListItemsResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getRadarValueListItemsResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000
- Must match pattern '^/v1/radar/value_list_items'

Instances

Instances details

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

mkGetRadarValueListItemsResponseBody200 Source #

Arguments

:: [Radar'valueListItem]	`getRadarValueListItemsResponseBody200Data`
-> Bool	`getRadarValueListItemsResponseBody200HasMore`
-> Text	`getRadarValueListItemsResponseBody200Url`
-> GetRadarValueListItemsResponseBody200

Create a new GetRadarValueListItemsResponseBody200 with all required fields.