Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.List_plans

Description

Contains the different functions to run the operation list_plans

Synopsis

list_plans :: forall m. MonadHTTP m => List_plansParameters -> ClientT m (Response List_plansResponse)
data List_plansParameters = List_plansParameters {
}
mkList_plansParameters :: List_plansParameters
data List_plansParametersQueryOrder
data List_plansParametersQuerySort
data List_plansParametersQueryState
data List_plansResponse
list_plansWithConfiguration :: forall m. MonadHTTP m => Configuration -> List_plansParameters -> m (Response List_plansResponse)
list_plansRaw :: forall m. MonadHTTP m => List_plansParameters -> ClientT m (Response ByteString)
list_plansWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> List_plansParameters -> m (Response ByteString)

Documentation

list_plans Source #

Arguments

:: forall m. MonadHTTP m
=> List_plansParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response List_plansResponse)	Monadic computation which returns the result of the operation

GET /plans

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

data List_plansParameters Source #

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

Constructors

List_plansParameters

Fields

list_plansParametersQueryBegin_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_plansParametersQueryEnd_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_plansParametersQueryIds :: 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_plansParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
Limit number of records 1-200.
Constraints:
- Maxium of 200.0
- Minimum of 1.0
list_plansParametersQueryOrder :: Maybe List_plansParametersQueryOrder
queryOrder: Represents the parameter named 'order'
Sort order.
list_plansParametersQuerySort :: Maybe List_plansParametersQuerySort
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_plansParametersQueryState :: Maybe List_plansParametersQueryState
queryState: Represents the parameter named 'state'
Filter by state.

Instances

Instances details

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

mkList_plansParameters :: List_plansParameters Source #

Create a new List_plansParameters with all required fields.

data List_plansParametersQueryOrder Source #

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

Represents the parameter named 'order'

Sort order.

Constructors

List_plansParametersQueryOrderOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_plansParametersQueryOrderTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_plansParametersQueryOrderEnumAsc	Represents the JSON value `"asc"`
List_plansParametersQueryOrderEnumDesc	Represents the JSON value `"desc"`

Instances

Instances details

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

data List_plansParametersQuerySort Source #

Defines the enum schema located at paths./plans.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_plansParametersQuerySortOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_plansParametersQuerySortTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_plansParametersQuerySortEnumCreated_at	Represents the JSON value `"created_at"`
List_plansParametersQuerySortEnumUpdated_at	Represents the JSON value `"updated_at"`

Instances

Instances details

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

data List_plansParametersQueryState Source #

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

Represents the parameter named 'state'

Filter by state.

Constructors

List_plansParametersQueryStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
List_plansParametersQueryStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
List_plansParametersQueryStateEnumActive	Represents the JSON value `"active"`
List_plansParametersQueryStateEnumInactive	Represents the JSON value `"inactive"`

Instances

Instances details

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

data List_plansResponse Source #

Represents a response of the operation list_plans.

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

Constructors

List_plansResponseError String	Means either no matching case available or a parse error
List_plansResponse200 PlanList	A list of plans.
List_plansResponse400 Error	Invalid or unpermitted parameter.
List_plansResponse404 Error	Incorrect site ID.
List_plansResponseDefault Error	Unexpected error.

Instances

Instances details

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

list_plansWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_plansParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response List_plansResponse)	Monadic computation which returns the result of the operation

GET /plans

The same as list_plans but accepts an explicit configuration.

list_plansRaw Source #

Arguments

:: forall m. MonadHTTP m
=> List_plansParameters	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 /plans

The same as list_plans but returns the raw ByteString.

list_plansWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> List_plansParameters	Contains all available parameters of this operation (query and path parameters)
-> m (Response ByteString)	Monadic computation which returns the result of the operation

GET /plans

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