Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
RecurlyClient.Operations.List_transactions
Description
Contains the different functions to run the operation list_transactions
Synopsis
- list_transactions :: forall m. MonadHTTP m => List_transactionsParameters -> ClientT m (Response List_transactionsResponse)
- data List_transactionsParameters = List_transactionsParameters {
- list_transactionsParametersQueryBegin_time :: Maybe JsonDateTime
- list_transactionsParametersQueryEnd_time :: Maybe JsonDateTime
- list_transactionsParametersQueryIds :: Maybe [Text]
- list_transactionsParametersQueryLimit :: Maybe Int
- list_transactionsParametersQueryOrder :: Maybe List_transactionsParametersQueryOrder
- list_transactionsParametersQuerySort :: Maybe List_transactionsParametersQuerySort
- list_transactionsParametersQuerySuccess :: Maybe List_transactionsParametersQuerySuccess
- list_transactionsParametersQueryType :: Maybe List_transactionsParametersQueryType
- mkList_transactionsParameters :: List_transactionsParameters
- data List_transactionsParametersQueryOrder
- data List_transactionsParametersQuerySort
- data List_transactionsParametersQuerySuccess
- data List_transactionsParametersQueryType
- = List_transactionsParametersQueryTypeOther Value
- | List_transactionsParametersQueryTypeTyped Text
- | List_transactionsParametersQueryTypeEnumAuthorization
- | List_transactionsParametersQueryTypeEnumCapture
- | List_transactionsParametersQueryTypeEnumPayment
- | List_transactionsParametersQueryTypeEnumPurchase
- | List_transactionsParametersQueryTypeEnumRefund
- | List_transactionsParametersQueryTypeEnumVerify
- data List_transactionsResponse
- list_transactionsWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_transactionsParameters -> m (Response List_transactionsResponse)
- list_transactionsRaw :: forall m. MonadHTTP m => List_transactionsParameters -> ClientT m (Response ByteString)
- list_transactionsWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_transactionsParameters -> m (Response ByteString)
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> List_transactionsParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response List_transactionsResponse) | Monadic computation which returns the result of the operation |
GET /transactions
See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
data List_transactionsParameters Source #
Defines the object schema located at paths./transactions.GET.parameters
in the specification.
Constructors
List_transactionsParameters | |
Fields
|
Instances
mkList_transactionsParameters :: List_transactionsParameters Source #
Create a new List_transactionsParameters
with all required fields.
data List_transactionsParametersQueryOrder Source #
Defines the enum schema located at paths./transactions.GET.parameters.properties.queryOrder
in the specification.
Represents the parameter named 'order'
Sort order.
Constructors
List_transactionsParametersQueryOrderOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_transactionsParametersQueryOrderTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_transactionsParametersQueryOrderEnumAsc | Represents the JSON value |
List_transactionsParametersQueryOrderEnumDesc | Represents the JSON value |
Instances
data List_transactionsParametersQuerySort Source #
Defines the enum schema located at paths./transactions.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_transactionsParametersQuerySortOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_transactionsParametersQuerySortTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_transactionsParametersQuerySortEnumCreated_at | Represents the JSON value |
List_transactionsParametersQuerySortEnumUpdated_at | Represents the JSON value |
Instances
data List_transactionsParametersQuerySuccess Source #
Defines the enum schema located at paths./transactions.GET.parameters.properties.querySuccess
in the specification.
Represents the parameter named 'success'
Filter by success field.
Constructors
List_transactionsParametersQuerySuccessOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_transactionsParametersQuerySuccessTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_transactionsParametersQuerySuccessEnumTrue | Represents the JSON value |
Instances
data List_transactionsParametersQueryType Source #
Defines the enum schema located at paths./transactions.GET.parameters.properties.queryType
in the specification.
Represents the parameter named 'type'
Filter by type field. The value `payment` will return both `purchase` and `capture` transactions.
Constructors
List_transactionsParametersQueryTypeOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_transactionsParametersQueryTypeTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_transactionsParametersQueryTypeEnumAuthorization | Represents the JSON value |
List_transactionsParametersQueryTypeEnumCapture | Represents the JSON value |
List_transactionsParametersQueryTypeEnumPayment | Represents the JSON value |
List_transactionsParametersQueryTypeEnumPurchase | Represents the JSON value |
List_transactionsParametersQueryTypeEnumRefund | Represents the JSON value |
List_transactionsParametersQueryTypeEnumVerify | Represents the JSON value |
Instances
data List_transactionsResponse Source #
Represents a response of the operation list_transactions
.
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_transactionsResponseError
is used.
Constructors
List_transactionsResponseError String | Means either no matching case available or a parse error |
List_transactionsResponse200 TransactionList | A list of the site's transactions. |
List_transactionsResponse400 Error | Invalid or unpermitted parameter. |
List_transactionsResponse404 Error | Incorrect site or subscription ID. |
List_transactionsResponseDefault Error | Unexpected error. |
Instances
Show List_transactionsResponse Source # | |
Defined in RecurlyClient.Operations.List_transactions Methods showsPrec :: Int -> List_transactionsResponse -> ShowS # show :: List_transactionsResponse -> String # showList :: [List_transactionsResponse] -> ShowS # | |
Eq List_transactionsResponse Source # | |
Defined in RecurlyClient.Operations.List_transactions Methods (==) :: List_transactionsResponse -> List_transactionsResponse -> Bool # (/=) :: List_transactionsResponse -> List_transactionsResponse -> Bool # |
list_transactionsWithConfiguration Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> List_transactionsParameters | Contains all available parameters of this operation (query and path parameters) |
-> m (Response List_transactionsResponse) | Monadic computation which returns the result of the operation |
GET /transactions
The same as list_transactions
but accepts an explicit configuration.
Arguments
:: forall m. MonadHTTP m | |
=> List_transactionsParameters | 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 /transactions
The same as list_transactions
but returns the raw ByteString
.
list_transactionsWithConfigurationRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> List_transactionsParameters | Contains all available parameters of this operation (query and path parameters) |
-> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /transactions
The same as list_transactions
but accepts an explicit configuration and returns the raw ByteString
.