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

RecurlyClient.Operations.List_measured_unit

Description

Contains the different functions to run the operation list_measured_unit

Synopsis

Documentation

list_measured_unit Source #

Arguments

:: forall m. MonadHTTP m 
=> List_measured_unitParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response List_measured_unitResponse)

Monadic computation which returns the result of the operation

GET /measured_units

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

data List_measured_unitParameters Source #

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

Constructors

List_measured_unitParameters 

Fields

data List_measured_unitParametersQueryOrder Source #

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

Represents the parameter named 'order'

Sort order.

Constructors

List_measured_unitParametersQueryOrderOther Value

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

List_measured_unitParametersQueryOrderTyped Text

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

List_measured_unitParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_measured_unitParametersQueryOrderEnumDesc

Represents the JSON value "desc"

data List_measured_unitParametersQuerySort Source #

Defines the enum schema located at paths./measured_units.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_measured_unitParametersQuerySortOther Value

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

List_measured_unitParametersQuerySortTyped Text

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

List_measured_unitParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_measured_unitParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

data List_measured_unitParametersQueryState Source #

Defines the enum schema located at paths./measured_units.GET.parameters.properties.queryState in the specification.

Represents the parameter named 'state'

Filter by state.

Constructors

List_measured_unitParametersQueryStateOther Value

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

List_measured_unitParametersQueryStateTyped Text

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

List_measured_unitParametersQueryStateEnumActive

Represents the JSON value "active"

List_measured_unitParametersQueryStateEnumInactive

Represents the JSON value "inactive"

data List_measured_unitResponse Source #

Represents a response of the operation list_measured_unit.

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

Constructors

List_measured_unitResponseError String

Means either no matching case available or a parse error

List_measured_unitResponse200 MeasuredUnitList

A list of the site's measured units.

List_measured_unitResponse404 Error

Incorrect site ID.

List_measured_unitResponseDefault Error

Unexpected error.

list_measured_unitWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_measured_unitParameters

Contains all available parameters of this operation (query and path parameters)

-> m (Response List_measured_unitResponse)

Monadic computation which returns the result of the operation

GET /measured_units

The same as list_measured_unit but accepts an explicit configuration.

list_measured_unitRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> List_measured_unitParameters

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

The same as list_measured_unit but returns the raw ByteString.

list_measured_unitWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_measured_unitParameters

Contains all available parameters of this operation (query and path parameters)

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /measured_units

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