Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
RecurlyClient.Operations.List_account_acquisition
Description
Contains the different functions to run the operation list_account_acquisition
Synopsis
- list_account_acquisition :: forall m. MonadHTTP m => List_account_acquisitionParameters -> ClientT m (Response List_account_acquisitionResponse)
- data List_account_acquisitionParameters = List_account_acquisitionParameters {
- list_account_acquisitionParametersQueryBegin_time :: Maybe JsonDateTime
- list_account_acquisitionParametersQueryEnd_time :: Maybe JsonDateTime
- list_account_acquisitionParametersQueryIds :: Maybe [Text]
- list_account_acquisitionParametersQueryLimit :: Maybe Int
- list_account_acquisitionParametersQueryOrder :: Maybe List_account_acquisitionParametersQueryOrder
- list_account_acquisitionParametersQuerySort :: Maybe List_account_acquisitionParametersQuerySort
- mkList_account_acquisitionParameters :: List_account_acquisitionParameters
- data List_account_acquisitionParametersQueryOrder
- data List_account_acquisitionParametersQuerySort
- data List_account_acquisitionResponse
- list_account_acquisitionWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_account_acquisitionParameters -> m (Response List_account_acquisitionResponse)
- list_account_acquisitionRaw :: forall m. MonadHTTP m => List_account_acquisitionParameters -> ClientT m (Response ByteString)
- list_account_acquisitionWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_account_acquisitionParameters -> m (Response ByteString)
Documentation
list_account_acquisition Source #
Arguments
:: forall m. MonadHTTP m | |
=> List_account_acquisitionParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response List_account_acquisitionResponse) | Monadic computation which returns the result of the operation |
GET /acquisitions
See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
data List_account_acquisitionParameters Source #
Defines the object schema located at paths./acquisitions.GET.parameters
in the specification.
Constructors
List_account_acquisitionParameters | |
Fields
|
Instances
mkList_account_acquisitionParameters :: List_account_acquisitionParameters Source #
Create a new List_account_acquisitionParameters
with all required fields.
data List_account_acquisitionParametersQueryOrder Source #
Defines the enum schema located at paths./acquisitions.GET.parameters.properties.queryOrder
in the specification.
Represents the parameter named 'order'
Sort order.
Constructors
List_account_acquisitionParametersQueryOrderOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_account_acquisitionParametersQueryOrderTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_account_acquisitionParametersQueryOrderEnumAsc | Represents the JSON value |
List_account_acquisitionParametersQueryOrderEnumDesc | Represents the JSON value |
Instances
data List_account_acquisitionParametersQuerySort Source #
Defines the enum schema located at paths./acquisitions.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_account_acquisitionParametersQuerySortOther Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
List_account_acquisitionParametersQuerySortTyped Text | This constructor can be used to send values to the server which are not present in the specification yet. |
List_account_acquisitionParametersQuerySortEnumCreated_at | Represents the JSON value |
List_account_acquisitionParametersQuerySortEnumUpdated_at | Represents the JSON value |
Instances
data List_account_acquisitionResponse Source #
Represents a response of the operation list_account_acquisition
.
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_account_acquisitionResponseError
is used.
Constructors
List_account_acquisitionResponseError String | Means either no matching case available or a parse error |
List_account_acquisitionResponse200 AccountAcquisitionList | A list of the site's account acquisition data. |
List_account_acquisitionResponse400 Error | Invalid or unpermitted parameter. |
List_account_acquisitionResponse404 Error | Incorrect site ID. |
List_account_acquisitionResponseDefault Error | Unexpected error. |
Instances
list_account_acquisitionWithConfiguration Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> List_account_acquisitionParameters | Contains all available parameters of this operation (query and path parameters) |
-> m (Response List_account_acquisitionResponse) | Monadic computation which returns the result of the operation |
GET /acquisitions
The same as list_account_acquisition
but accepts an explicit configuration.
list_account_acquisitionRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> List_account_acquisitionParameters | 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 /acquisitions
The same as list_account_acquisition
but returns the raw ByteString
.
list_account_acquisitionWithConfigurationRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> List_account_acquisitionParameters | Contains all available parameters of this operation (query and path parameters) |
-> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /acquisitions
The same as list_account_acquisition
but accepts an explicit configuration and returns the raw ByteString
.