Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetRadarValueListItems

Contains the different functions to run the operation getRadarValueListItems

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetRadarValueListItems.hs

valuegetRadarValueListItems

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

datadata GetRadarValueListItemsParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRadarValueListItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
Show GetRadarValueListItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
FromJSON GetRadarValueListItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
ToJSON GetRadarValueListItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems

valuemkGetRadarValueListItemsParameters

:: Text
getRadarValueListItemsParametersQueryValueList
-> GetRadarValueListItemsParameters

Create a new GetRadarValueListItemsParameters with all required fields.

datadata GetRadarValueListItemsParametersQueryCreated'OneOf1

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRadarValueListItemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
Show GetRadarValueListItemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
FromJSON GetRadarValueListItemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
ToJSON GetRadarValueListItemsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems

valuemkGetRadarValueListItemsParametersQueryCreated'OneOf1 :: GetRadarValueListItemsParametersQueryCreated'OneOf1

Create a new GetRadarValueListItemsParametersQueryCreated'OneOf1 with all required fields.

datadata GetRadarValueListItemsParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRadarValueListItemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
Show GetRadarValueListItemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
FromJSON GetRadarValueListItemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
ToJSON GetRadarValueListItemsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems

datadata GetRadarValueListItemsResponse

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.

Instances2Eq, Show

Eq GetRadarValueListItemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
Show GetRadarValueListItemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems

datadata GetRadarValueListItemsResponseBody200

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetRadarValueListItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
Show GetRadarValueListItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
FromJSON GetRadarValueListItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems
ToJSON GetRadarValueListItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetRadarValueListItems

valuemkGetRadarValueListItemsResponseBody200

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

Create a new GetRadarValueListItemsResponseBody200 with all required fields.