Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Get_account_note

Description

Contains the different functions to run the operation get_account_note

Synopsis

get_account_note :: forall m. MonadHTTP m => Get_account_noteParameters -> ClientT m (Response Get_account_noteResponse)
data Get_account_noteParameters = Get_account_noteParameters {
- get_account_noteParametersPathAccount_id :: Text
- get_account_noteParametersPathAccount_note_id :: Text
}
mkGet_account_noteParameters :: Text -> Text -> Get_account_noteParameters
data Get_account_noteResponse
get_account_noteWithConfiguration :: forall m. MonadHTTP m => Configuration -> Get_account_noteParameters -> m (Response Get_account_noteResponse)
get_account_noteRaw :: forall m. MonadHTTP m => Get_account_noteParameters -> ClientT m (Response ByteString)
get_account_noteWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Get_account_noteParameters -> m (Response ByteString)

Documentation

get_account_note Source #

Arguments

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

GET /accounts/{account_id}/notes/{account_note_id}

Fetch an account note

data Get_account_noteParameters Source #

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

Constructors

Get_account_noteParameters
Fields get_account_noteParametersPathAccount_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`. get_account_noteParametersPathAccount_note_id :: Text pathAccount_note_id: Represents the parameter named 'account_note_id' Account Note ID.

Instances

Instances details

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

mkGet_account_noteParameters Source #

Arguments

:: Text	`get_account_noteParametersPathAccount_id`
-> Text	`get_account_noteParametersPathAccount_note_id`
-> Get_account_noteParameters

Create a new Get_account_noteParameters with all required fields.

data Get_account_noteResponse Source #

Represents a response of the operation get_account_note.

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), Get_account_noteResponseError is used.

Constructors

Get_account_noteResponseError String	Means either no matching case available or a parse error
Get_account_noteResponse200 AccountNote	An account note.
Get_account_noteResponse404 Error	Incorrect site, account or note ID.
Get_account_noteResponseDefault Error	Unexpected error.

Instances

Instances details

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

get_account_noteWithConfiguration Source #

Arguments

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

GET /accounts/{account_id}/notes/{account_note_id}

The same as get_account_note but accepts an explicit configuration.

get_account_noteRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Get_account_noteParameters	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/{account_note_id}

The same as get_account_note but returns the raw ByteString.

get_account_noteWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Get_account_noteParameters	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/{account_note_id}

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