| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetRadarValueListItems
Description
Contains the different functions to run the operation getRadarValueListItems
Synopsis
- getRadarValueListItems :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> m (Either HttpException (Response GetRadarValueListItemsResponse))
- getRadarValueListItemsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> m (Either HttpException (Response ByteString))
- getRadarValueListItemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRadarValueListItemsResponse))
- getRadarValueListItemsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetRadarValueListItemsRequestBody = GetRadarValueListItemsRequestBody {
- data GetRadarValueListItemsResponse
- data GetRadarValueListItemsResponseBody200 = GetRadarValueListItemsResponseBody200 {}
- data GetRadarValueListItemsResponseBody200Object'
Documentation
getRadarValueListItems Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | created |
| -> 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 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 String | value: Return items belonging to the parent list whose value matches the specified value (using an "is like" match). | Constraints: Maximum length of 800 |
| -> String | value_list: Identifier for the parent value list this item belongs to. | Constraints: Maximum length of 5000 |
| -> GetRadarValueListItemsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetRadarValueListItemsResponse)) | Monad containing 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>
getRadarValueListItemsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/radar/value_list_items
The same as getRadarValueListItems but returns the raw ByteString
getRadarValueListItemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRadarValueListItemsResponse)) Source #
GET /v1/radar/value_list_items
Monadic version of getRadarValueListItems (use with runWithConfiguration)
getRadarValueListItemsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> String -> GetRadarValueListItemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/radar/value_list_items
Monadic version of getRadarValueListItemsRaw (use with runWithConfiguration)
data GetRadarValueListItemsRequestBody Source #
Defines the data type for the schema getRadarValueListItemsRequestBody
Constructors
| GetRadarValueListItemsRequestBody | |
Instances
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
data GetRadarValueListItemsResponseBody200 Source #
Defines the data type for the schema GetRadarValueListItemsResponseBody200
Constructors
| GetRadarValueListItemsResponseBody200 | |
Fields
| |
Instances
data GetRadarValueListItemsResponseBody200Object' Source #
Defines the enum schema GetRadarValueListItemsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetRadarValueListItemsResponseBody200Object'EnumOther Value | |
| GetRadarValueListItemsResponseBody200Object'EnumTyped String | |
| GetRadarValueListItemsResponseBody200Object'EnumStringList |