recurly-client-0.1.0.0: Client for Recurly subscription management
Safe HaskellSafe-Inferred
LanguageHaskell2010

RecurlyClient.Operations.List_dunning_campaigns

Description

Contains the different functions to run the operation list_dunning_campaigns

Synopsis

Documentation

list_dunning_campaigns Source #

Arguments

:: forall m. MonadHTTP m 
=> Maybe List_dunning_campaignsParametersSort

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_dunning_campaignsResponse)

Monadic computation which returns the result of the operation

GET /dunning_campaigns

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

data List_dunning_campaignsParametersSort 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_dunning_campaignsParametersSortOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_dunning_campaignsParametersSortTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_dunning_campaignsParametersSortEnumCreated_at

Represents the JSON value "created_at"

List_dunning_campaignsParametersSortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

Instances details
FromJSON List_dunning_campaignsParametersSort Source # 
Instance details

Defined in RecurlyClient.Operations.List_dunning_campaigns

Methods

parseJSON :: Value -> Parser List_dunning_campaignsParametersSort #

parseJSONList :: Value -> Parser [List_dunning_campaignsParametersSort] #

ToJSON List_dunning_campaignsParametersSort Source # 
Instance details

Defined in RecurlyClient.Operations.List_dunning_campaigns

Methods

toJSON :: List_dunning_campaignsParametersSort -> Value #

toEncoding :: List_dunning_campaignsParametersSort -> Encoding #

toJSONList :: [List_dunning_campaignsParametersSort] -> Value #

toEncodingList :: [List_dunning_campaignsParametersSort] -> Encoding #

Show List_dunning_campaignsParametersSort Source # 
Instance details

Defined in RecurlyClient.Operations.List_dunning_campaigns

Methods

showsPrec :: Int -> List_dunning_campaignsParametersSort -> ShowS #

show :: List_dunning_campaignsParametersSort -> String #

showList :: [List_dunning_campaignsParametersSort] -> ShowS #

Eq List_dunning_campaignsParametersSort Source # 
Instance details

Defined in RecurlyClient.Operations.List_dunning_campaigns

Methods

(==) :: List_dunning_campaignsParametersSort -> List_dunning_campaignsParametersSort -> Bool #

(/=) :: List_dunning_campaignsParametersSort -> List_dunning_campaignsParametersSort -> Bool #

data List_dunning_campaignsResponse Source #

Represents a response of the operation list_dunning_campaigns.

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

Constructors

List_dunning_campaignsResponseError String

Means either no matching case available or a parse error

List_dunning_campaignsResponse200 DunningCampaignList

A list of the the dunning_campaigns on an account.

List_dunning_campaignsResponse404 Error

Incorrect site.

List_dunning_campaignsResponseDefault Error

Unexpected error.

Instances

Instances details
Show List_dunning_campaignsResponse Source # 
Instance details

Defined in RecurlyClient.Operations.List_dunning_campaigns

Methods

showsPrec :: Int -> List_dunning_campaignsResponse -> ShowS #

show :: List_dunning_campaignsResponse -> String #

showList :: [List_dunning_campaignsResponse] -> ShowS #

Eq List_dunning_campaignsResponse Source # 
Instance details

Defined in RecurlyClient.Operations.List_dunning_campaigns

Methods

(==) :: List_dunning_campaignsResponse -> List_dunning_campaignsResponse -> Bool #

(/=) :: List_dunning_campaignsResponse -> List_dunning_campaignsResponse -> Bool #

list_dunning_campaignsWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> Maybe List_dunning_campaignsParametersSort

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_dunning_campaignsResponse)

Monadic computation which returns the result of the operation

GET /dunning_campaigns

The same as list_dunning_campaigns but accepts an explicit configuration.

list_dunning_campaignsRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Maybe List_dunning_campaignsParametersSort

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 /dunning_campaigns

The same as list_dunning_campaigns but returns the raw ByteString.

list_dunning_campaignsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> Maybe List_dunning_campaignsParametersSort

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 /dunning_campaigns

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