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

RecurlyClient.Operations.List_account_notes

Description

Contains the different functions to run the operation list_account_notes

Synopsis

Documentation

list_account_notes Source #

Arguments

:: forall m. MonadHTTP m 
=> List_account_notesParameters

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

-> ClientT m (Response List_account_notesResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/notes

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

data List_account_notesParameters Source #

Defines the object schema located at paths./accounts/{account_id}/notes.GET.parameters in the specification.

Constructors

List_account_notesParameters 

Fields

  • list_account_notesParametersPathAccount_id :: Text

    pathAccount_id: Represents the parameter named 'account_id'

    Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

  • list_account_notesParametersQueryIds :: 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.

Instances

Instances details
FromJSON List_account_notesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_notes

Methods

parseJSON :: Value -> Parser List_account_notesParameters #

parseJSONList :: Value -> Parser [List_account_notesParameters] #

ToJSON List_account_notesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_notes

Methods

toJSON :: List_account_notesParameters -> Value #

toEncoding :: List_account_notesParameters -> Encoding #

toJSONList :: [List_account_notesParameters] -> Value #

toEncodingList :: [List_account_notesParameters] -> Encoding #

Show List_account_notesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_notes

Methods

showsPrec :: Int -> List_account_notesParameters -> ShowS #

show :: List_account_notesParameters -> String #

showList :: [List_account_notesParameters] -> ShowS #

Eq List_account_notesParameters Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_notes

Methods

(==) :: List_account_notesParameters -> List_account_notesParameters -> Bool #

(/=) :: List_account_notesParameters -> List_account_notesParameters -> Bool #

mkList_account_notesParameters Source #

Arguments

:: Text

list_account_notesParametersPathAccount_id

-> List_account_notesParameters 

Create a new List_account_notesParameters with all required fields.

data List_account_notesResponse Source #

Represents a response of the operation list_account_notes.

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

Constructors

List_account_notesResponseError String

Means either no matching case available or a parse error

List_account_notesResponse200 AccountNoteList

A list of an account's notes.

List_account_notesResponse404 Error

Incorrect site or account ID.

List_account_notesResponseDefault Error

Unexpected error.

Instances

Instances details
Show List_account_notesResponse Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_notes

Methods

showsPrec :: Int -> List_account_notesResponse -> ShowS #

show :: List_account_notesResponse -> String #

showList :: [List_account_notesResponse] -> ShowS #

Eq List_account_notesResponse Source # 
Instance details

Defined in RecurlyClient.Operations.List_account_notes

Methods

(==) :: List_account_notesResponse -> List_account_notesResponse -> Bool #

(/=) :: List_account_notesResponse -> List_account_notesResponse -> Bool #

list_account_notesWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_account_notesParameters

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

-> m (Response List_account_notesResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/notes

The same as list_account_notes but accepts an explicit configuration.

list_account_notesRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> List_account_notesParameters

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 /accounts/{account_id}/notes

The same as list_account_notes but returns the raw ByteString.

list_account_notesWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_account_notesParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/notes

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