Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_items

Description

Contains the different functions to run the operation list_items

Synopsis

list_items :: forall m. MonadHTTP m => List_itemsParameters -> ClientT m (Response List_itemsResponse)
data List_itemsParameters = List_itemsParameters {
}
mkList_itemsParameters :: List_itemsParameters
data List_itemsParametersQueryOrder
data List_itemsParametersQuerySort
data List_itemsParametersQueryState
data List_itemsResponse
list_itemsWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_itemsParameters -> m (Response List_itemsResponse)
list_itemsRaw :: forall m. MonadHTTP m => List_itemsParameters -> ClientT m (Response ByteString)
list_itemsWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_itemsParameters -> m (Response ByteString)

Documentation

list_items Source #

Arguments

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

GET /items

See the Pagination Guide to learn how to use pagination in the API and Client Libraries.

data List_itemsParameters Source #

Defines the object schema located at paths./items.GET.parameters in the specification.

Constructors

List_itemsParameters

Fields

list_itemsParametersQueryBegin_time :: Maybe JsonDateTime
queryBegin_time: Represents the parameter named 'begin_time'
Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
list_itemsParametersQueryEnd_time :: Maybe JsonDateTime
queryEnd_time: Represents the parameter named 'end_time'
Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
list_itemsParametersQueryIds :: Maybe [Text]
queryIds: Represents the parameter named 'ids'
Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.
- *Important notes:**
- The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
- Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
- Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
list_itemsParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
Limit number of records 1-200.
Constraints:
- Maxium of 200.0
- Minimum of 1.0
list_itemsParametersQueryOrder :: Maybe List_itemsParametersQueryOrder
queryOrder: Represents the parameter named 'order'
Sort order.
list_itemsParametersQuerySort :: Maybe List_itemsParametersQuerySort
querySort: Represents the parameter named 'sort'
Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
list_itemsParametersQueryState :: Maybe List_itemsParametersQueryState
queryState: Represents the parameter named 'state'
Filter by state.

Instances

Instances details

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

mkList_itemsParameters :: List_itemsParameters Source #

Create a new List_itemsParameters with all required fields.

data List_itemsParametersQueryOrder Source #

Defines the enum schema located at paths./items.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

List_itemsParametersQueryOrderOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_itemsParametersQueryOrderTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_itemsParametersQueryOrderEnumAsc	Represents the JSON value `"asc"`
List_itemsParametersQueryOrderEnumDesc	Represents the JSON value `"desc"`

Instances

Instances details

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

data List_itemsParametersQuerySort Source #

Defines the enum schema located at paths./items.GET.parameters.properties.querySort in the specification.

Represents the parameter named 'sort'

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Constructors

List_itemsParametersQuerySortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_itemsParametersQuerySortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_itemsParametersQuerySortEnumCreated_at	Represents the JSON value `"created_at"`
List_itemsParametersQuerySortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_itemsParametersQueryState Source #

Defines the enum schema located at paths./items.GET.parameters.properties.queryState in the specification.

Represents the parameter named 'state'

Filter by state.

Constructors

List_itemsParametersQueryStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_itemsParametersQueryStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_itemsParametersQueryStateEnumActive	Represents the JSON value `"active"`
List_itemsParametersQueryStateEnumInactive	Represents the JSON value `"inactive"`

Instances

Instances details

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

data List_itemsResponse Source #

Represents a response of the operation list_items.

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

Constructors

List_itemsResponseError String	Means either no matching case available or a parse error
List_itemsResponse200 ItemList	A list of the site's items.
List_itemsResponse400 Error	Invalid or unpermitted parameter.
List_itemsResponse404 Error	Incorrect site ID.
List_itemsResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_itemsWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_itemsParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response List_itemsResponse)	Monadic computation which returns the result of the operation

GET /items

The same as list_items but accepts an explicit configuration.

list_itemsRaw Source #

Arguments

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

GET /items

The same as list_items but returns the raw ByteString.

list_itemsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_itemsParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response ByteString)	Monadic computation which returns the result of the operation

GET /items

The same as list_items but accepts an explicit configuration and returns the raw ByteString.