RecurlyClient.Operations.List_sites

Contains the different functions to run the operation list_sites

Documentation

list_sites

Arguments

:: forall m. MonadHTTP m

=> List_sitesParameters

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

-> ClientT m (Response List_sitesResponse)

Monadic computation which returns the result of the operation

GET /sites

This route is most useful for finding a site's ID for subsequent requests.

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

data List_sitesParameters

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

Constructors

List_sitesParameters

Fields

• list_sitesParametersQueryIds :: 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_sitesParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  Limit number of records 1-200.

  Constraints:

  • Maxium of 200.0
  • Minimum of 1.0
• list_sitesParametersQueryOrder :: Maybe List_sitesParametersQueryOrder

  queryOrder: Represents the parameter named 'order'

  Sort order.

• list_sitesParametersQuerySort :: Maybe List_sitesParametersQuerySort

  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_sitesParametersQueryState :: Maybe List_sitesParametersQueryState

  queryState: Represents the parameter named 'state'

  Filter by state.

Instances

FromJSON List_sitesParameters

Defined in RecurlyClient.Operations.List_sites

Methods

parseJSON :: Value -> Parser List_sitesParameters

parseJSONList :: Value -> Parser [List_sitesParameters]

ToJSON List_sitesParameters

Defined in RecurlyClient.Operations.List_sites

Methods

toJSON :: List_sitesParameters -> Value

toEncoding :: List_sitesParameters -> Encoding

toJSONList :: [List_sitesParameters] -> Value

toEncodingList :: [List_sitesParameters] -> Encoding

Show List_sitesParameters

Defined in RecurlyClient.Operations.List_sites

Methods

showsPrec :: Int -> List_sitesParameters -> ShowS

show :: List_sitesParameters -> String

showList :: [List_sitesParameters] -> ShowS

Eq List_sitesParameters

Defined in RecurlyClient.Operations.List_sites

Methods

(==) :: List_sitesParameters -> List_sitesParameters -> Bool

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

mkList_sitesParameters :: List_sitesParameters

Create a new List_sitesParameters with all required fields.

data List_sitesParametersQueryOrder

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

Represents the parameter named 'order'

Sort order.

Constructors

List_sitesParametersQueryOrderOther Value

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

List_sitesParametersQueryOrderTyped Text

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

List_sitesParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_sitesParametersQueryOrderEnumDesc

Represents the JSON value "desc"

Instances

FromJSON List_sitesParametersQueryOrder

Defined in RecurlyClient.Operations.List_sites

Methods

parseJSON :: Value -> Parser List_sitesParametersQueryOrder

parseJSONList :: Value -> Parser [List_sitesParametersQueryOrder]

ToJSON List_sitesParametersQueryOrder

Defined in RecurlyClient.Operations.List_sites

Methods

toJSON :: List_sitesParametersQueryOrder -> Value

toEncoding :: List_sitesParametersQueryOrder -> Encoding

toJSONList :: [List_sitesParametersQueryOrder] -> Value

toEncodingList :: [List_sitesParametersQueryOrder] -> Encoding

Show List_sitesParametersQueryOrder

Defined in RecurlyClient.Operations.List_sites

Methods

showsPrec :: Int -> List_sitesParametersQueryOrder -> ShowS

show :: List_sitesParametersQueryOrder -> String

showList :: [List_sitesParametersQueryOrder] -> ShowS

Eq List_sitesParametersQueryOrder

Defined in RecurlyClient.Operations.List_sites

Methods

(==) :: List_sitesParametersQueryOrder -> List_sitesParametersQueryOrder -> Bool

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

data List_sitesParametersQuerySort

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

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

List_sitesParametersQuerySortTyped Text

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

List_sitesParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_sitesParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

FromJSON List_sitesParametersQuerySort

Defined in RecurlyClient.Operations.List_sites

Methods

parseJSON :: Value -> Parser List_sitesParametersQuerySort

parseJSONList :: Value -> Parser [List_sitesParametersQuerySort]

ToJSON List_sitesParametersQuerySort

Defined in RecurlyClient.Operations.List_sites

Methods

toJSON :: List_sitesParametersQuerySort -> Value

toEncoding :: List_sitesParametersQuerySort -> Encoding

toJSONList :: [List_sitesParametersQuerySort] -> Value

toEncodingList :: [List_sitesParametersQuerySort] -> Encoding

Show List_sitesParametersQuerySort

Defined in RecurlyClient.Operations.List_sites

Methods

showsPrec :: Int -> List_sitesParametersQuerySort -> ShowS

show :: List_sitesParametersQuerySort -> String

showList :: [List_sitesParametersQuerySort] -> ShowS

Eq List_sitesParametersQuerySort

Defined in RecurlyClient.Operations.List_sites

Methods

(==) :: List_sitesParametersQuerySort -> List_sitesParametersQuerySort -> Bool

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

data List_sitesParametersQueryState

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

Represents the parameter named 'state'

Filter by state.

Constructors

List_sitesParametersQueryStateOther Value

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

List_sitesParametersQueryStateTyped Text

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

List_sitesParametersQueryStateEnumActive

Represents the JSON value "active"

List_sitesParametersQueryStateEnumInactive

Represents the JSON value "inactive"

Instances

FromJSON List_sitesParametersQueryState

Defined in RecurlyClient.Operations.List_sites

Methods

parseJSON :: Value -> Parser List_sitesParametersQueryState

parseJSONList :: Value -> Parser [List_sitesParametersQueryState]

ToJSON List_sitesParametersQueryState

Defined in RecurlyClient.Operations.List_sites

Methods

toJSON :: List_sitesParametersQueryState -> Value

toEncoding :: List_sitesParametersQueryState -> Encoding

toJSONList :: [List_sitesParametersQueryState] -> Value

toEncodingList :: [List_sitesParametersQueryState] -> Encoding

Show List_sitesParametersQueryState

Defined in RecurlyClient.Operations.List_sites

Methods

showsPrec :: Int -> List_sitesParametersQueryState -> ShowS

show :: List_sitesParametersQueryState -> String

showList :: [List_sitesParametersQueryState] -> ShowS

Eq List_sitesParametersQueryState

Defined in RecurlyClient.Operations.List_sites

Methods

(==) :: List_sitesParametersQueryState -> List_sitesParametersQueryState -> Bool

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

data List_sitesResponse

Represents a response of the operation list_sites.

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

Constructors

List_sitesResponseError String

Means either no matching case available or a parse error

List_sitesResponse200 SiteList

A list of sites.

List_sitesResponse400 Error

Invalid or unpermitted parameter.

List_sitesResponseDefault Error

Unexpected error.

Instances

Show List_sitesResponse

Defined in RecurlyClient.Operations.List_sites

Methods

showsPrec :: Int -> List_sitesResponse -> ShowS

show :: List_sitesResponse -> String

showList :: [List_sitesResponse] -> ShowS

Eq List_sitesResponse

Defined in RecurlyClient.Operations.List_sites

Methods

(==) :: List_sitesResponse -> List_sitesResponse -> Bool

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

list_sitesWithConfiguration

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_sitesParameters

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

-> m (Response List_sitesResponse)

Monadic computation which returns the result of the operation

GET /sites

The same as list_sites but accepts an explicit configuration.

list_sitesRaw

Arguments

:: forall m. MonadHTTP m

=> List_sitesParameters

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

The same as list_sites but returns the raw ByteString.

list_sitesWithConfigurationRaw

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_sitesParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /sites

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