Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_external_subscriptions

Description

Contains the different functions to run the operation list_external_subscriptions

Synopsis

Documentation

list_external_subscriptions Source #

Arguments

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

GET /external_subscriptions

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

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

Instances

Instances details

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

data List_external_subscriptionsResponse Source #

Represents a response of the operation list_external_subscriptions.

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

Constructors

List_external_subscriptionsResponseError String	Means either no matching case available or a parse error
List_external_subscriptionsResponse200 ExternalSubscriptionList	A list of the the external_subscriptions on a site.
List_external_subscriptionsResponse404 Error	Incorrect site.
List_external_subscriptionsResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_external_subscriptionsWithConfiguration Source #

Arguments

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

GET /external_subscriptions

The same as list_external_subscriptions but accepts an explicit configuration.

list_external_subscriptionsRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_external_subscriptionsParametersSort	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_subscriptions

The same as list_external_subscriptions but returns the raw ByteString.

list_external_subscriptionsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Maybe List_external_subscriptionsParametersSort	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_subscriptions

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