Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Cloudflare.Types

Synopsis

data CloudflareAuth = CloudflareAuth {
- cloudflareAuthToken :: Text
}
data Account = Account {
- accountId :: Text
- accountName :: Text
}
newtype ResultOnly a = ResultOnly {
- resultOnlyResult :: a
}
data ResponseError = ResponseError {
- responseErrorCode :: Int
- responseErrorMessage :: Text
}
data ResponseMessage = ResponseMessage {
- responseMessageCode :: Int
- responseMessageMessage :: Text
}
data ResultInfo = ResultInfo {
- resultInfoCount :: Int
- resultInfoPage :: Int
- resultInfoPerPage :: Int
- resultInfoTotalCount :: Int
}
data ResultResponse a = ResultResponse {
- resultErrors :: [ResponseError]
- resultMessages :: [ResponseMessage]
- resultSuccess :: Bool
- resultResult :: a
}
data ResultWithInfo a = ResultWithInfo {
- resultWithInfoInfo :: ResultInfo
- resultWithInfoErrors :: [ResponseError]
- resultWithInfoMessages :: [ResponseMessage]
- resultWithInfoSuccess :: Bool
- resultWithInfoResult :: a
}

Documentation

data CloudflareAuth Source #

Cloudflare API token see https://developers.cloudflare.com/fundamentals/api/get-started/create-token/ for instructions on creating a token

Constructors

CloudflareAuth
Fields cloudflareAuthToken :: Text

data Account Source #

Cloudflare account information

Constructors

Account
Fields accountId :: Text Cloudflare account ID accountName :: Text Cloudflare account name

Instances

Instances details

FromJSON Account Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser Account parseJSONList :: Value -> Parser [Account] omittedField :: Maybe Account
Show Account Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> Account -> ShowS Source # show :: Account -> String Source # showList :: [Account] -> ShowS Source #
Eq Account Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: Account -> Account -> Bool Source # (/=) :: Account -> Account -> Bool Source #
Ord Account Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: Account -> Account -> Ordering Source # (<) :: Account -> Account -> Bool Source # (<=) :: Account -> Account -> Bool Source # (>) :: Account -> Account -> Bool Source # (>=) :: Account -> Account -> Bool Source # max :: Account -> Account -> Account Source # min :: Account -> Account -> Account Source #

newtype ResultOnly a Source #

Result type for Cloudflare API calls that don't return any extra data and wrap the result in a "result" field

Constructors

ResultOnly
Fields resultOnlyResult :: a

Instances

Instances details

FromJSON a => FromJSON (ResultOnly a) Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser (ResultOnly a) parseJSONList :: Value -> Parser [ResultOnly a] omittedField :: Maybe (ResultOnly a)
Show a => Show (ResultOnly a) Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> ResultOnly a -> ShowS Source # show :: ResultOnly a -> String Source # showList :: [ResultOnly a] -> ShowS Source #
Eq a => Eq (ResultOnly a) Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: ResultOnly a -> ResultOnly a -> Bool Source # (/=) :: ResultOnly a -> ResultOnly a -> Bool Source #
Ord a => Ord (ResultOnly a) Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: ResultOnly a -> ResultOnly a -> Ordering Source # (<) :: ResultOnly a -> ResultOnly a -> Bool Source # (<=) :: ResultOnly a -> ResultOnly a -> Bool Source # (>) :: ResultOnly a -> ResultOnly a -> Bool Source # (>=) :: ResultOnly a -> ResultOnly a -> Bool Source # max :: ResultOnly a -> ResultOnly a -> ResultOnly a Source # min :: ResultOnly a -> ResultOnly a -> ResultOnly a Source #

data ResponseError Source #

Result type for Cloudflare API call errors

Constructors

ResponseError
Fields responseErrorCode :: Int responseErrorMessage :: Text

Instances

Instances details

FromJSON ResponseError Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser ResponseError parseJSONList :: Value -> Parser [ResponseError] omittedField :: Maybe ResponseError
Show ResponseError Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> ResponseError -> ShowS Source # show :: ResponseError -> String Source # showList :: [ResponseError] -> ShowS Source #
Eq ResponseError Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: ResponseError -> ResponseError -> Bool Source # (/=) :: ResponseError -> ResponseError -> Bool Source #
Ord ResponseError Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: ResponseError -> ResponseError -> Ordering Source # (<) :: ResponseError -> ResponseError -> Bool Source # (<=) :: ResponseError -> ResponseError -> Bool Source # (>) :: ResponseError -> ResponseError -> Bool Source # (>=) :: ResponseError -> ResponseError -> Bool Source # max :: ResponseError -> ResponseError -> ResponseError Source # min :: ResponseError -> ResponseError -> ResponseError Source #

data ResponseMessage Source #

Additional messages from Cloudflare API calls

Constructors

ResponseMessage
Fields responseMessageCode :: Int responseMessageMessage :: Text

Instances

Instances details

FromJSON ResponseMessage Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser ResponseMessage parseJSONList :: Value -> Parser [ResponseMessage] omittedField :: Maybe ResponseMessage
Show ResponseMessage Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> ResponseMessage -> ShowS Source # show :: ResponseMessage -> String Source # showList :: [ResponseMessage] -> ShowS Source #
Eq ResponseMessage Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: ResponseMessage -> ResponseMessage -> Bool Source # (/=) :: ResponseMessage -> ResponseMessage -> Bool Source #
Ord ResponseMessage Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: ResponseMessage -> ResponseMessage -> Ordering Source # (<) :: ResponseMessage -> ResponseMessage -> Bool Source # (<=) :: ResponseMessage -> ResponseMessage -> Bool Source # (>) :: ResponseMessage -> ResponseMessage -> Bool Source # (>=) :: ResponseMessage -> ResponseMessage -> Bool Source # max :: ResponseMessage -> ResponseMessage -> ResponseMessage Source # min :: ResponseMessage -> ResponseMessage -> ResponseMessage Source #

data ResultInfo Source #

Result information for Cloudflare API calls that return a list of results

Constructors

ResultInfo
Fields resultInfoCount :: Int resultInfoPage :: Int resultInfoPerPage :: Int resultInfoTotalCount :: Int

Instances

Instances details

FromJSON ResultInfo Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser ResultInfo parseJSONList :: Value -> Parser [ResultInfo] omittedField :: Maybe ResultInfo
Show ResultInfo Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> ResultInfo -> ShowS Source # show :: ResultInfo -> String Source # showList :: [ResultInfo] -> ShowS Source #
Eq ResultInfo Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: ResultInfo -> ResultInfo -> Bool Source # (/=) :: ResultInfo -> ResultInfo -> Bool Source #
Ord ResultInfo Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: ResultInfo -> ResultInfo -> Ordering Source # (<) :: ResultInfo -> ResultInfo -> Bool Source # (<=) :: ResultInfo -> ResultInfo -> Bool Source # (>) :: ResultInfo -> ResultInfo -> Bool Source # (>=) :: ResultInfo -> ResultInfo -> Bool Source # max :: ResultInfo -> ResultInfo -> ResultInfo Source # min :: ResultInfo -> ResultInfo -> ResultInfo Source #

data ResultResponse a Source #

Result type for Cloudflare API calls that returns a result with a list of errors, a list of messages, and a success flag

Constructors

ResultResponse
Fields resultErrors :: [ResponseError] resultMessages :: [ResponseMessage] resultSuccess :: Bool resultResult :: a

Instances

Instances details

FromJSON a => FromJSON (ResultResponse a) Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser (ResultResponse a) parseJSONList :: Value -> Parser [ResultResponse a] omittedField :: Maybe (ResultResponse a)
Show a => Show (ResultResponse a) Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> ResultResponse a -> ShowS Source # show :: ResultResponse a -> String Source # showList :: [ResultResponse a] -> ShowS Source #
Eq a => Eq (ResultResponse a) Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: ResultResponse a -> ResultResponse a -> Bool Source # (/=) :: ResultResponse a -> ResultResponse a -> Bool Source #
Ord a => Ord (ResultResponse a) Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: ResultResponse a -> ResultResponse a -> Ordering Source # (<) :: ResultResponse a -> ResultResponse a -> Bool Source # (<=) :: ResultResponse a -> ResultResponse a -> Bool Source # (>) :: ResultResponse a -> ResultResponse a -> Bool Source # (>=) :: ResultResponse a -> ResultResponse a -> Bool Source # max :: ResultResponse a -> ResultResponse a -> ResultResponse a Source # min :: ResultResponse a -> ResultResponse a -> ResultResponse a Source #

data ResultWithInfo a Source #

Result type for Cloudflare API calls that returns a result with meta information about the result, a list of errors, a list of messages, and a success flag

Constructors

ResultWithInfo
Fields resultWithInfoInfo :: ResultInfo resultWithInfoErrors :: [ResponseError] resultWithInfoMessages :: [ResponseMessage] resultWithInfoSuccess :: Bool resultWithInfoResult :: a

Instances

Instances details

FromJSON a => FromJSON (ResultWithInfo a) Source #
Instance details Defined in Network.Cloudflare.Types Methods parseJSON :: Value -> Parser (ResultWithInfo a) parseJSONList :: Value -> Parser [ResultWithInfo a] omittedField :: Maybe (ResultWithInfo a)
Show a => Show (ResultWithInfo a) Source #
Instance details Defined in Network.Cloudflare.Types Methods showsPrec :: Int -> ResultWithInfo a -> ShowS Source # show :: ResultWithInfo a -> String Source # showList :: [ResultWithInfo a] -> ShowS Source #
Eq a => Eq (ResultWithInfo a) Source #
Instance details Defined in Network.Cloudflare.Types Methods (==) :: ResultWithInfo a -> ResultWithInfo a -> Bool Source # (/=) :: ResultWithInfo a -> ResultWithInfo a -> Bool Source #
Ord a => Ord (ResultWithInfo a) Source #
Instance details Defined in Network.Cloudflare.Types Methods compare :: ResultWithInfo a -> ResultWithInfo a -> Ordering Source # (<) :: ResultWithInfo a -> ResultWithInfo a -> Bool Source # (<=) :: ResultWithInfo a -> ResultWithInfo a -> Bool Source # (>) :: ResultWithInfo a -> ResultWithInfo a -> Bool Source # (>=) :: ResultWithInfo a -> ResultWithInfo a -> Bool Source # max :: ResultWithInfo a -> ResultWithInfo a -> ResultWithInfo a Source # min :: ResultWithInfo a -> ResultWithInfo a -> ResultWithInfo a Source #