Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_credit_payments

Description

Contains the different functions to run the operation list_credit_payments

Synopsis

list_credit_payments :: forall m. MonadHTTP m => List_credit_paymentsParameters -> ClientT m (Response List_credit_paymentsResponse)
data List_credit_paymentsParameters = List_credit_paymentsParameters {
}
mkList_credit_paymentsParameters :: List_credit_paymentsParameters
data List_credit_paymentsParametersQueryOrder
data List_credit_paymentsParametersQuerySort
data List_credit_paymentsResponse
list_credit_paymentsWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_credit_paymentsParameters -> m (Response List_credit_paymentsResponse)
list_credit_paymentsRaw :: forall m. MonadHTTP m => List_credit_paymentsParameters -> ClientT m (Response ByteString)
list_credit_paymentsWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_credit_paymentsParameters -> m (Response ByteString)

Documentation

list_credit_payments Source #

Arguments

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

GET /credit_payments

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

data List_credit_paymentsParameters Source #

Defines the object schema located at paths./credit_payments.GET.parameters in the specification.

Constructors

List_credit_paymentsParameters

Fields

list_credit_paymentsParametersQueryBegin_time :: Maybe JsonDateTime
queryBegin_time: Represents the parameter named 'begin_time'
Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
list_credit_paymentsParametersQueryEnd_time :: Maybe JsonDateTime
queryEnd_time: Represents the parameter named 'end_time'
Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
list_credit_paymentsParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
Limit number of records 1-200.
Constraints:
- Maxium of 200.0
- Minimum of 1.0
list_credit_paymentsParametersQueryOrder :: Maybe List_credit_paymentsParametersQueryOrder
queryOrder: Represents the parameter named 'order'
Sort order.
list_credit_paymentsParametersQuerySort :: Maybe List_credit_paymentsParametersQuerySort
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_credit_paymentsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_credit_payments Methods parseJSON :: Value -> Parser List_credit_paymentsParameters # parseJSONList :: Value -> Parser [List_credit_paymentsParameters] #
ToJSON List_credit_paymentsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_credit_payments Methods toJSON :: List_credit_paymentsParameters -> Value # toEncoding :: List_credit_paymentsParameters -> Encoding # toJSONList :: [List_credit_paymentsParameters] -> Value # toEncodingList :: [List_credit_paymentsParameters] -> Encoding #
Show List_credit_paymentsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_credit_payments Methods showsPrec :: Int -> List_credit_paymentsParameters -> ShowS # show :: List_credit_paymentsParameters -> String # showList :: [List_credit_paymentsParameters] -> ShowS #
Eq List_credit_paymentsParameters Source #
Instance details Defined in RecurlyClient.Operations.List_credit_payments Methods (==) :: List_credit_paymentsParameters -> List_credit_paymentsParameters -> Bool # (/=) :: List_credit_paymentsParameters -> List_credit_paymentsParameters -> Bool #

mkList_credit_paymentsParameters :: List_credit_paymentsParameters Source #

Create a new List_credit_paymentsParameters with all required fields.

data List_credit_paymentsParametersQueryOrder Source #

Defines the enum schema located at paths./credit_payments.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

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

Instances

Instances details

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

data List_credit_paymentsParametersQuerySort Source #

Defines the enum schema located at paths./credit_payments.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_credit_paymentsParametersQuerySortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_credit_paymentsParametersQuerySortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_credit_paymentsParametersQuerySortEnumCreated_at	Represents the JSON value `"created_at"`
List_credit_paymentsParametersQuerySortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_credit_paymentsResponse Source #

Represents a response of the operation list_credit_payments.

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

Constructors

List_credit_paymentsResponseError String	Means either no matching case available or a parse error
List_credit_paymentsResponse200 CreditPaymentList	A list of the site's credit payments.
List_credit_paymentsResponse400 Error	Invalid or unpermitted parameter.
List_credit_paymentsResponse404 Error	Incorrect site or account ID.
List_credit_paymentsResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_credit_paymentsWithConfiguration Source #

Arguments

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

GET /credit_payments

The same as list_credit_payments but accepts an explicit configuration.

list_credit_paymentsRaw Source #

Arguments

:: forall m. MonadHTTP m
=> List_credit_paymentsParameters	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 /credit_payments

The same as list_credit_payments but returns the raw ByteString.

list_credit_paymentsWithConfigurationRaw Source #

Arguments

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

GET /credit_payments

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