Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_external_products

Description

Contains the different functions to run the operation list_external_products

Synopsis

list_external_products :: forall m. MonadHTTP m => Maybe List_external_productsParametersSort -> ClientT m (Response List_external_productsResponse)
data List_external_productsParametersSort
data List_external_productsResponse
list_external_productsWithConfiguration :: forall m. MonadHTTP m => Configuration -> Maybe List_external_productsParametersSort -> m (Response List_external_productsResponse)
list_external_productsRaw :: forall m. MonadHTTP m => Maybe List_external_productsParametersSort -> ClientT m (Response ByteString)
list_external_productsWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Maybe List_external_productsParametersSort -> m (Response ByteString)

Documentation

list_external_products Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_external_productsParametersSort	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.
-> ClientT m (Response List_external_productsResponse)	Monadic computation which returns the result of the operation

GET /external_products

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

data List_external_productsParametersSort Source #

Defines the enum schema located at components.parameters.sort_dates.schema 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_external_productsParametersSortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_external_productsParametersSortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_external_productsParametersSortEnumCreated_at	Represents the JSON value `"created_at"`
List_external_productsParametersSortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_external_productsResponse Source #

Represents a response of the operation list_external_products.

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_external_productsResponseError is used.

Constructors

List_external_productsResponseError String	Means either no matching case available or a parse error
List_external_productsResponse200 ExternalProductList	A list of the the external_products on a site.
List_external_productsResponse404 Error	Incorrect site.
List_external_productsResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_external_productsWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Maybe List_external_productsParametersSort	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.
-> m (Response List_external_productsResponse)	Monadic computation which returns the result of the operation

GET /external_products

The same as list_external_products but accepts an explicit configuration.

list_external_productsRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_external_productsParametersSort	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.
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

GET /external_products

The same as list_external_products but returns the raw ByteString.

list_external_productsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Maybe List_external_productsParametersSort	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.
-> m (Response ByteString)	Monadic computation which returns the result of the operation

GET /external_products

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