| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Get_site
Description
Contains the different functions to run the operation get_site
Synopsis
- get_site :: forall m. MonadHTTP m => Text -> ClientT m (Response Get_siteResponse)
- data Get_siteResponse
- get_siteWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Get_siteResponse)
- get_siteRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
- get_siteWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Text | site_id: Site ID or subdomain. For ID no prefix is used e.g. `e28zov4fw0v2`. For subdomain use prefix `subdomain-`, e.g. `subdomain-recurly`. |
| -> ClientT m (Response Get_siteResponse) | Monadic computation which returns the result of the operation |
GET /sites/{site_id}Fetch a site
data Get_siteResponse Source #
Represents a response of the operation get_site.
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_siteResponseError is used.
Constructors
| Get_siteResponseError String | Means either no matching case available or a parse error |
| Get_siteResponse200 Site | A site. |
| Get_siteResponse404 Error | Incorrect site ID. |
| Get_siteResponseDefault Error | Unexpected error. |
Instances
| Show Get_siteResponse Source # | |
Defined in RecurlyClient.Operations.Get_site Methods showsPrec :: Int -> Get_siteResponse -> ShowS # show :: Get_siteResponse -> String # showList :: [Get_siteResponse] -> ShowS # | |
| Eq Get_siteResponse Source # | |
Defined in RecurlyClient.Operations.Get_site Methods (==) :: Get_siteResponse -> Get_siteResponse -> Bool # (/=) :: Get_siteResponse -> Get_siteResponse -> Bool # | |
get_siteWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | site_id: Site ID or subdomain. For ID no prefix is used e.g. `e28zov4fw0v2`. For subdomain use prefix `subdomain-`, e.g. `subdomain-recurly`. |
| -> m (Response Get_siteResponse) | Monadic computation which returns the result of the operation |
GET /sites/{site_id}The same as get_site but accepts an explicit configuration.
Arguments
| :: forall m. MonadHTTP m | |
| => Text | site_id: Site ID or subdomain. For ID no prefix is used e.g. `e28zov4fw0v2`. For subdomain use prefix `subdomain-`, e.g. `subdomain-recurly`. |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /sites/{site_id}The same as get_site but returns the raw ByteString.
get_siteWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | site_id: Site ID or subdomain. For ID no prefix is used e.g. `e28zov4fw0v2`. For subdomain use prefix `subdomain-`, e.g. `subdomain-recurly`. |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
GET /sites/{site_id}The same as get_site but accepts an explicit configuration and returns the raw ByteString.