Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_external_product_external_product_references

Description

Contains the different functions to run the operation list_external_product_external_product_references

Synopsis

list_external_product_external_product_references :: forall m. MonadHTTP m => Maybe List_external_product_external_product_referencesParametersSort -> ClientT m (Response List_external_product_external_product_referencesResponse)
data List_external_product_external_product_referencesParametersSort
data List_external_product_external_product_referencesResponse
list_external_product_external_product_referencesWithConfiguration :: forall m. MonadHTTP m => Configuration -> Maybe List_external_product_external_product_referencesParametersSort -> m (Response List_external_product_external_product_referencesResponse)
list_external_product_external_product_referencesRaw :: forall m. MonadHTTP m => Maybe List_external_product_external_product_referencesParametersSort -> ClientT m (Response ByteString)
list_external_product_external_product_referencesWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Maybe List_external_product_external_product_referencesParametersSort -> m (Response ByteString)

Documentation

list_external_product_external_product_references Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_external_product_external_product_referencesParametersSort	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_product_external_product_referencesResponse)	Monadic computation which returns the result of the operation

GET /external_products/{external_product_id}/external_product_references

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

data List_external_product_external_product_referencesParametersSort 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_product_external_product_referencesParametersSortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_external_product_external_product_referencesParametersSortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_external_product_external_product_referencesParametersSortEnumCreated_at	Represents the JSON value `"created_at"`
List_external_product_external_product_referencesParametersSortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_external_product_external_product_referencesResponse Source #

Represents a response of the operation list_external_product_external_product_references.

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

Constructors

List_external_product_external_product_referencesResponseError String	Means either no matching case available or a parse error
List_external_product_external_product_referencesResponse200 ExternalProductReferenceCollection	A list of the the external product references for an external product.
List_external_product_external_product_referencesResponse404 Error	Incorrect site or external product ID.
List_external_product_external_product_referencesResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_external_product_external_product_referencesWithConfiguration Source #

Arguments

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

GET /external_products/{external_product_id}/external_product_references

The same as list_external_product_external_product_references but accepts an explicit configuration.

list_external_product_external_product_referencesRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_external_product_external_product_referencesParametersSort	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/{external_product_id}/external_product_references

The same as list_external_product_external_product_references but returns the raw ByteString.

list_external_product_external_product_referencesWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Maybe List_external_product_external_product_referencesParametersSort	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/{external_product_id}/external_product_references

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