RecurlyClient.Operations.List_add_ons

Contains the different functions to run the operation list_add_ons

Documentation

list_add_ons

Arguments

:: forall m. MonadHTTP m

=> List_add_onsParameters

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

-> ClientT m (Response List_add_onsResponse)

Monadic computation which returns the result of the operation

GET /add_ons

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

data List_add_onsParameters

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

Constructors

List_add_onsParameters

Fields

• list_add_onsParametersQueryBegin_time :: Maybe JsonDateTime

  queryBegin_time: Represents the parameter named 'begin_time'

  Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_add_onsParametersQueryEnd_time :: Maybe JsonDateTime

  queryEnd_time: Represents the parameter named 'end_time'

  Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_add_onsParametersQueryIds :: Maybe [Text]

  queryIds: Represents the parameter named 'ids'

  Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.

  • *Important notes:**
  • The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
  • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
  • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
• list_add_onsParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  Limit number of records 1-200.

  Constraints:

  • Maxium of 200.0
  • Minimum of 1.0
• list_add_onsParametersQueryOrder :: Maybe List_add_onsParametersQueryOrder

  queryOrder: Represents the parameter named 'order'

  Sort order.

• list_add_onsParametersQuerySort :: Maybe List_add_onsParametersQuerySort

  querySort: 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.

• list_add_onsParametersQueryState :: Maybe List_add_onsParametersQueryState

  queryState: Represents the parameter named 'state'

  Filter by state.

Instances

FromJSON List_add_onsParameters

Defined in RecurlyClient.Operations.List_add_ons

Methods

parseJSON :: Value -> Parser List_add_onsParameters

parseJSONList :: Value -> Parser [List_add_onsParameters]

ToJSON List_add_onsParameters

Defined in RecurlyClient.Operations.List_add_ons

Methods

toJSON :: List_add_onsParameters -> Value

toEncoding :: List_add_onsParameters -> Encoding

toJSONList :: [List_add_onsParameters] -> Value

toEncodingList :: [List_add_onsParameters] -> Encoding

Show List_add_onsParameters

Defined in RecurlyClient.Operations.List_add_ons

Methods

showsPrec :: Int -> List_add_onsParameters -> ShowS

show :: List_add_onsParameters -> String

showList :: [List_add_onsParameters] -> ShowS

Eq List_add_onsParameters

Defined in RecurlyClient.Operations.List_add_ons

Methods

(==) :: List_add_onsParameters -> List_add_onsParameters -> Bool

(/=) :: List_add_onsParameters -> List_add_onsParameters -> Bool

mkList_add_onsParameters :: List_add_onsParameters

Create a new List_add_onsParameters with all required fields.

data List_add_onsParametersQueryOrder

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

Represents the parameter named 'order'

Sort order.

Constructors

List_add_onsParametersQueryOrderOther Value

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

List_add_onsParametersQueryOrderTyped Text

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

List_add_onsParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_add_onsParametersQueryOrderEnumDesc

Represents the JSON value "desc"

Instances

FromJSON List_add_onsParametersQueryOrder

Defined in RecurlyClient.Operations.List_add_ons

Methods

parseJSON :: Value -> Parser List_add_onsParametersQueryOrder

parseJSONList :: Value -> Parser [List_add_onsParametersQueryOrder]

ToJSON List_add_onsParametersQueryOrder

Defined in RecurlyClient.Operations.List_add_ons

Methods

toJSON :: List_add_onsParametersQueryOrder -> Value

toEncoding :: List_add_onsParametersQueryOrder -> Encoding

toJSONList :: [List_add_onsParametersQueryOrder] -> Value

toEncodingList :: [List_add_onsParametersQueryOrder] -> Encoding

Show List_add_onsParametersQueryOrder

Defined in RecurlyClient.Operations.List_add_ons

Methods

showsPrec :: Int -> List_add_onsParametersQueryOrder -> ShowS

show :: List_add_onsParametersQueryOrder -> String

showList :: [List_add_onsParametersQueryOrder] -> ShowS

Eq List_add_onsParametersQueryOrder

Defined in RecurlyClient.Operations.List_add_ons

Methods

(==) :: List_add_onsParametersQueryOrder -> List_add_onsParametersQueryOrder -> Bool

(/=) :: List_add_onsParametersQueryOrder -> List_add_onsParametersQueryOrder -> Bool

data List_add_onsParametersQuerySort

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

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

List_add_onsParametersQuerySortTyped Text

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

List_add_onsParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_add_onsParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

FromJSON List_add_onsParametersQuerySort

Defined in RecurlyClient.Operations.List_add_ons

Methods

parseJSON :: Value -> Parser List_add_onsParametersQuerySort

parseJSONList :: Value -> Parser [List_add_onsParametersQuerySort]

ToJSON List_add_onsParametersQuerySort

Defined in RecurlyClient.Operations.List_add_ons

Methods

toJSON :: List_add_onsParametersQuerySort -> Value

toEncoding :: List_add_onsParametersQuerySort -> Encoding

toJSONList :: [List_add_onsParametersQuerySort] -> Value

toEncodingList :: [List_add_onsParametersQuerySort] -> Encoding

Show List_add_onsParametersQuerySort

Defined in RecurlyClient.Operations.List_add_ons

Methods

showsPrec :: Int -> List_add_onsParametersQuerySort -> ShowS

show :: List_add_onsParametersQuerySort -> String

showList :: [List_add_onsParametersQuerySort] -> ShowS

Eq List_add_onsParametersQuerySort

Defined in RecurlyClient.Operations.List_add_ons

Methods

(==) :: List_add_onsParametersQuerySort -> List_add_onsParametersQuerySort -> Bool

(/=) :: List_add_onsParametersQuerySort -> List_add_onsParametersQuerySort -> Bool

data List_add_onsParametersQueryState

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

Represents the parameter named 'state'

Filter by state.

Constructors

List_add_onsParametersQueryStateOther Value

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

List_add_onsParametersQueryStateTyped Text

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

List_add_onsParametersQueryStateEnumActive

Represents the JSON value "active"

List_add_onsParametersQueryStateEnumInactive

Represents the JSON value "inactive"

Instances

FromJSON List_add_onsParametersQueryState

Defined in RecurlyClient.Operations.List_add_ons

Methods

parseJSON :: Value -> Parser List_add_onsParametersQueryState

parseJSONList :: Value -> Parser [List_add_onsParametersQueryState]

ToJSON List_add_onsParametersQueryState

Defined in RecurlyClient.Operations.List_add_ons

Methods

toJSON :: List_add_onsParametersQueryState -> Value

toEncoding :: List_add_onsParametersQueryState -> Encoding

toJSONList :: [List_add_onsParametersQueryState] -> Value

toEncodingList :: [List_add_onsParametersQueryState] -> Encoding

Show List_add_onsParametersQueryState

Defined in RecurlyClient.Operations.List_add_ons

Methods

showsPrec :: Int -> List_add_onsParametersQueryState -> ShowS

show :: List_add_onsParametersQueryState -> String

showList :: [List_add_onsParametersQueryState] -> ShowS

Eq List_add_onsParametersQueryState

Defined in RecurlyClient.Operations.List_add_ons

Methods

(==) :: List_add_onsParametersQueryState -> List_add_onsParametersQueryState -> Bool

(/=) :: List_add_onsParametersQueryState -> List_add_onsParametersQueryState -> Bool

data List_add_onsResponse

Represents a response of the operation list_add_ons.

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

Constructors

List_add_onsResponseError String

Means either no matching case available or a parse error

List_add_onsResponse200 AddOnList

A list of add-ons.

List_add_onsResponse400 Error

Invalid or unpermitted parameter.

List_add_onsResponse404 Error

Incorrect site or add-on ID.

List_add_onsResponseDefault Error

Unexpected error.

Instances

Show List_add_onsResponse

Defined in RecurlyClient.Operations.List_add_ons

Methods

showsPrec :: Int -> List_add_onsResponse -> ShowS

show :: List_add_onsResponse -> String

showList :: [List_add_onsResponse] -> ShowS

Eq List_add_onsResponse

Defined in RecurlyClient.Operations.List_add_ons

Methods

(==) :: List_add_onsResponse -> List_add_onsResponse -> Bool

(/=) :: List_add_onsResponse -> List_add_onsResponse -> Bool

list_add_onsWithConfiguration

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_add_onsParameters

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

-> m (Response List_add_onsResponse)

Monadic computation which returns the result of the operation

GET /add_ons

The same as list_add_ons but accepts an explicit configuration.

list_add_onsRaw

Arguments

:: forall m. MonadHTTP m

=> List_add_onsParameters

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

The same as list_add_ons but returns the raw ByteString.

list_add_onsWithConfigurationRaw

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_add_onsParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /add_ons

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