Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_invoice_templates

Description

Contains the different functions to run the operation list_invoice_templates

Synopsis

list_invoice_templates :: forall m. MonadHTTP m => Maybe List_invoice_templatesParametersSort -> ClientT m (Response List_invoice_templatesResponse)
data List_invoice_templatesParametersSort
data List_invoice_templatesResponse
list_invoice_templatesWithConfiguration :: forall m. MonadHTTP m => Configuration -> Maybe List_invoice_templatesParametersSort -> m (Response List_invoice_templatesResponse)
list_invoice_templatesRaw :: forall m. MonadHTTP m => Maybe List_invoice_templatesParametersSort -> ClientT m (Response ByteString)
list_invoice_templatesWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Maybe List_invoice_templatesParametersSort -> m (Response ByteString)

Documentation

list_invoice_templates Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_invoice_templatesParametersSort	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_invoice_templatesResponse)	Monadic computation which returns the result of the operation

GET /invoice_templates

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

data List_invoice_templatesParametersSort 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_invoice_templatesParametersSortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_invoice_templatesParametersSortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_invoice_templatesParametersSortEnumCreated_at	Represents the JSON value `"created_at"`
List_invoice_templatesParametersSortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_invoice_templatesResponse Source #

Represents a response of the operation list_invoice_templates.

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

Constructors

List_invoice_templatesResponseError String	Means either no matching case available or a parse error
List_invoice_templatesResponse200 InvoiceTemplateList	A list of the the invoice templates on a site.
List_invoice_templatesResponse404 Error	Incorrect site.
List_invoice_templatesResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_invoice_templatesWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Maybe List_invoice_templatesParametersSort	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_invoice_templatesResponse)	Monadic computation which returns the result of the operation

GET /invoice_templates

The same as list_invoice_templates but accepts an explicit configuration.

list_invoice_templatesRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Maybe List_invoice_templatesParametersSort	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 /invoice_templates

The same as list_invoice_templates but returns the raw ByteString.

list_invoice_templatesWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Maybe List_invoice_templatesParametersSort	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 /invoice_templates

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