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

RecurlyClient.Operations.List_shipping_methods

Description

Contains the different functions to run the operation list_shipping_methods

Synopsis

Documentation

list_shipping_methods Source #

Arguments

:: forall m. MonadHTTP m 
=> List_shipping_methodsParameters

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

-> ClientT m (Response List_shipping_methodsResponse)

Monadic computation which returns the result of the operation

GET /shipping_methods

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

data List_shipping_methodsParameters Source #

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

Constructors

List_shipping_methodsParameters 

Fields

data List_shipping_methodsParametersQueryOrder Source #

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

Represents the parameter named 'order'

Sort order.

Constructors

List_shipping_methodsParametersQueryOrderOther Value

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

List_shipping_methodsParametersQueryOrderTyped Text

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

List_shipping_methodsParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_shipping_methodsParametersQueryOrderEnumDesc

Represents the JSON value "desc"

data List_shipping_methodsParametersQuerySort Source #

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

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

List_shipping_methodsParametersQuerySortTyped Text

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

List_shipping_methodsParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_shipping_methodsParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

data List_shipping_methodsResponse Source #

Represents a response of the operation list_shipping_methods.

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

Constructors

List_shipping_methodsResponseError String

Means either no matching case available or a parse error

List_shipping_methodsResponse200 ShippingMethodList

A list of the site's shipping methods.

List_shipping_methodsResponse400 Error

Invalid or unpermitted parameter.

List_shipping_methodsResponse404 Error

Incorrect site ID.

List_shipping_methodsResponseDefault Error

Unexpected error.

list_shipping_methodsWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_shipping_methodsParameters

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

-> m (Response List_shipping_methodsResponse)

Monadic computation which returns the result of the operation

GET /shipping_methods

The same as list_shipping_methods but accepts an explicit configuration.

list_shipping_methodsRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> List_shipping_methodsParameters

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

The same as list_shipping_methods but returns the raw ByteString.

list_shipping_methodsWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_shipping_methodsParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /shipping_methods

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