Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
RecurlyClient.Operations.Get_custom_field_definition
Description
Contains the different functions to run the operation get_custom_field_definition
Synopsis
- get_custom_field_definition :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_custom_field_definitionResponse)
- data Get_custom_field_definitionResponse
- get_custom_field_definitionWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_custom_field_definitionResponse)
- get_custom_field_definitionRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
- get_custom_field_definitionWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)
Documentation
get_custom_field_definition Source #
Arguments
:: forall m. MonadHTTP m | |
=> Text | custom_field_definition_id: Custom Field Definition ID |
-> ClientT m (Response Get_custom_field_definitionResponse) | Monadic computation which returns the result of the operation |
GET /custom_field_definitions/{custom_field_definition_id}
Fetch an custom field definition
data Get_custom_field_definitionResponse Source #
Represents a response of the operation get_custom_field_definition
.
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_custom_field_definitionResponseError
is used.
Constructors
Get_custom_field_definitionResponseError String | Means either no matching case available or a parse error |
Get_custom_field_definitionResponse200 CustomFieldDefinition | A custom field definition. |
Get_custom_field_definitionResponse404 Error | Incorrect site or custom field definition ID. |
Get_custom_field_definitionResponseDefault Error | Unexpected error. |
Instances
get_custom_field_definitionWithConfiguration Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> Text | custom_field_definition_id: Custom Field Definition ID |
-> m (Response Get_custom_field_definitionResponse) | Monadic computation which returns the result of the operation |
GET /custom_field_definitions/{custom_field_definition_id}
The same as get_custom_field_definition
but accepts an explicit configuration.
get_custom_field_definitionRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Text | custom_field_definition_id: Custom Field Definition ID |
-> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /custom_field_definitions/{custom_field_definition_id}
The same as get_custom_field_definition
but returns the raw ByteString
.
get_custom_field_definitionWithConfigurationRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> Text | custom_field_definition_id: Custom Field Definition ID |
-> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /custom_field_definitions/{custom_field_definition_id}
The same as get_custom_field_definition
but accepts an explicit configuration and returns the raw ByteString
.