Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_external_subscription_external_payment_phases

Description

Contains the different functions to run the operation list_external_subscription_external_payment_phases

Synopsis

list_external_subscription_external_payment_phases :: forall m. MonadHTTP m => List_external_subscription_external_payment_phasesParameters -> ClientT m (Response List_external_subscription_external_payment_phasesResponse)
data List_external_subscription_external_payment_phasesParameters = List_external_subscription_external_payment_phasesParameters {
}
mkList_external_subscription_external_payment_phasesParameters :: List_external_subscription_external_payment_phasesParameters
data List_external_subscription_external_payment_phasesParametersQueryOrder
data List_external_subscription_external_payment_phasesParametersQuerySort
data List_external_subscription_external_payment_phasesResponse
list_external_subscription_external_payment_phasesWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_external_subscription_external_payment_phasesParameters -> m (Response List_external_subscription_external_payment_phasesResponse)
list_external_subscription_external_payment_phasesRaw :: forall m. MonadHTTP m => List_external_subscription_external_payment_phasesParameters -> ClientT m (Response ByteString)
list_external_subscription_external_payment_phasesWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_external_subscription_external_payment_phasesParameters -> m (Response ByteString)

Documentation

list_external_subscription_external_payment_phases Source #

Arguments

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

GET /external_subscriptions/{external_subscription_id}/external_payment_phases

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

data List_external_subscription_external_payment_phasesParameters Source #

Defines the object schema located at paths./external_subscriptions/{external_subscription_id}/external_payment_phases.GET.parameters in the specification.

Constructors

List_external_subscription_external_payment_phasesParameters

Fields

list_external_subscription_external_payment_phasesParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
Limit number of records 1-200.
Constraints:
- Maxium of 200.0
- Minimum of 1.0
list_external_subscription_external_payment_phasesParametersQueryOrder :: Maybe List_external_subscription_external_payment_phasesParametersQueryOrder
queryOrder: Represents the parameter named 'order'
Sort order.
list_external_subscription_external_payment_phasesParametersQuerySort :: Maybe List_external_subscription_external_payment_phasesParametersQuerySort
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.

Instances

Instances details

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

mkList_external_subscription_external_payment_phasesParameters :: List_external_subscription_external_payment_phasesParameters Source #

Create a new List_external_subscription_external_payment_phasesParameters with all required fields.

data List_external_subscription_external_payment_phasesParametersQueryOrder Source #

Defines the enum schema located at paths./external_subscriptions/{external_subscription_id}/external_payment_phases.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

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

Instances

Instances details

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

data List_external_subscription_external_payment_phasesParametersQuerySort Source #

Defines the enum schema located at paths./external_subscriptions/{external_subscription_id}/external_payment_phases.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_external_subscription_external_payment_phasesParametersQuerySortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_external_subscription_external_payment_phasesParametersQuerySortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_external_subscription_external_payment_phasesParametersQuerySortEnumCreated_at	Represents the JSON value `"created_at"`
List_external_subscription_external_payment_phasesParametersQuerySortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_external_subscription_external_payment_phasesResponse Source #

Represents a response of the operation list_external_subscription_external_payment_phases.

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

Constructors

List_external_subscription_external_payment_phasesResponseError String	Means either no matching case available or a parse error
List_external_subscription_external_payment_phasesResponse200 ExternalPaymentPhaseList	A list of the the external_payment_phases on a site.
List_external_subscription_external_payment_phasesResponse404 Error	Incorrect site.
List_external_subscription_external_payment_phasesResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_external_subscription_external_payment_phasesWithConfiguration Source #

Arguments

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

GET /external_subscriptions/{external_subscription_id}/external_payment_phases

The same as list_external_subscription_external_payment_phases but accepts an explicit configuration.

list_external_subscription_external_payment_phasesRaw Source #

Arguments

:: forall m. MonadHTTP m
=> List_external_subscription_external_payment_phasesParameters	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 /external_subscriptions/{external_subscription_id}/external_payment_phases

The same as list_external_subscription_external_payment_phases but returns the raw ByteString.

list_external_subscription_external_payment_phasesWithConfigurationRaw Source #

Arguments

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

GET /external_subscriptions/{external_subscription_id}/external_payment_phases

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