RecurlyClient.Operations.List_invoice_coupon_redemptions

Contains the different functions to run the operation list_invoice_coupon_redemptions

Documentation

list_invoice_coupon_redemptions

Arguments

:: forall m. MonadHTTP m

=> List_invoice_coupon_redemptionsParameters

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

-> ClientT m (Response List_invoice_coupon_redemptionsResponse)

Monadic computation which returns the result of the operation

GET /invoices/{invoice_id}/coupon_redemptions

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

data List_invoice_coupon_redemptionsParameters

Defines the object schema located at paths./invoices/{invoice_id}/coupon_redemptions.GET.parameters in the specification.

Constructors

List_invoice_coupon_redemptionsParameters

Fields

• list_invoice_coupon_redemptionsParametersPathInvoice_id :: Text

  pathInvoice_id: Represents the parameter named 'invoice_id'

  Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.

• list_invoice_coupon_redemptionsParametersQueryBegin_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_invoice_coupon_redemptionsParametersQueryEnd_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_invoice_coupon_redemptionsParametersQueryIds :: 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_invoice_coupon_redemptionsParametersQuerySort :: Maybe List_invoice_coupon_redemptionsParametersQuerySort

  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.

Instances

FromJSON List_invoice_coupon_redemptionsParameters

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

parseJSON :: Value -> Parser List_invoice_coupon_redemptionsParameters

parseJSONList :: Value -> Parser [List_invoice_coupon_redemptionsParameters]

ToJSON List_invoice_coupon_redemptionsParameters

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

toJSON :: List_invoice_coupon_redemptionsParameters -> Value

toEncoding :: List_invoice_coupon_redemptionsParameters -> Encoding

toJSONList :: [List_invoice_coupon_redemptionsParameters] -> Value

toEncodingList :: [List_invoice_coupon_redemptionsParameters] -> Encoding

Show List_invoice_coupon_redemptionsParameters

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

showsPrec :: Int -> List_invoice_coupon_redemptionsParameters -> ShowS

show :: List_invoice_coupon_redemptionsParameters -> String

showList :: [List_invoice_coupon_redemptionsParameters] -> ShowS

Eq List_invoice_coupon_redemptionsParameters

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

(==) :: List_invoice_coupon_redemptionsParameters -> List_invoice_coupon_redemptionsParameters -> Bool

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

mkList_invoice_coupon_redemptionsParameters

Arguments

:: Text

list_invoice_coupon_redemptionsParametersPathInvoice_id

-> List_invoice_coupon_redemptionsParameters

Create a new List_invoice_coupon_redemptionsParameters with all required fields.

data List_invoice_coupon_redemptionsParametersQuerySort

Defines the enum schema located at paths./invoices/{invoice_id}/coupon_redemptions.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_invoice_coupon_redemptionsParametersQuerySortOther Value

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

List_invoice_coupon_redemptionsParametersQuerySortTyped Text

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

List_invoice_coupon_redemptionsParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_invoice_coupon_redemptionsParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

FromJSON List_invoice_coupon_redemptionsParametersQuerySort

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

parseJSON :: Value -> Parser List_invoice_coupon_redemptionsParametersQuerySort

parseJSONList :: Value -> Parser [List_invoice_coupon_redemptionsParametersQuerySort]

ToJSON List_invoice_coupon_redemptionsParametersQuerySort

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

toJSON :: List_invoice_coupon_redemptionsParametersQuerySort -> Value

toEncoding :: List_invoice_coupon_redemptionsParametersQuerySort -> Encoding

toJSONList :: [List_invoice_coupon_redemptionsParametersQuerySort] -> Value

toEncodingList :: [List_invoice_coupon_redemptionsParametersQuerySort] -> Encoding

Show List_invoice_coupon_redemptionsParametersQuerySort

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

showsPrec :: Int -> List_invoice_coupon_redemptionsParametersQuerySort -> ShowS

show :: List_invoice_coupon_redemptionsParametersQuerySort -> String

showList :: [List_invoice_coupon_redemptionsParametersQuerySort] -> ShowS

Eq List_invoice_coupon_redemptionsParametersQuerySort

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

(==) :: List_invoice_coupon_redemptionsParametersQuerySort -> List_invoice_coupon_redemptionsParametersQuerySort -> Bool

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

data List_invoice_coupon_redemptionsResponse

Represents a response of the operation list_invoice_coupon_redemptions.

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

Constructors

List_invoice_coupon_redemptionsResponseError String

Means either no matching case available or a parse error

List_invoice_coupon_redemptionsResponse200 CouponRedemptionList

A list of the the coupon redemptions associated with the invoice.

List_invoice_coupon_redemptionsResponse404 Error

Incorrect site or invoice ID.

List_invoice_coupon_redemptionsResponseDefault Error

Unexpected error.

Instances

Show List_invoice_coupon_redemptionsResponse

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

showsPrec :: Int -> List_invoice_coupon_redemptionsResponse -> ShowS

show :: List_invoice_coupon_redemptionsResponse -> String

showList :: [List_invoice_coupon_redemptionsResponse] -> ShowS

Eq List_invoice_coupon_redemptionsResponse

Defined in RecurlyClient.Operations.List_invoice_coupon_redemptions

Methods

(==) :: List_invoice_coupon_redemptionsResponse -> List_invoice_coupon_redemptionsResponse -> Bool

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

list_invoice_coupon_redemptionsWithConfiguration

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_invoice_coupon_redemptionsParameters

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

-> m (Response List_invoice_coupon_redemptionsResponse)

Monadic computation which returns the result of the operation

GET /invoices/{invoice_id}/coupon_redemptions

The same as list_invoice_coupon_redemptions but accepts an explicit configuration.

list_invoice_coupon_redemptionsRaw

Arguments

:: forall m. MonadHTTP m

=> List_invoice_coupon_redemptionsParameters

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 /invoices/{invoice_id}/coupon_redemptions

The same as list_invoice_coupon_redemptions but returns the raw ByteString.

list_invoice_coupon_redemptionsWithConfigurationRaw

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_invoice_coupon_redemptionsParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /invoices/{invoice_id}/coupon_redemptions

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