Safe Haskell	None
Language	Haskell2010

Web.Pixela

Contents

Types
User functions
Graph functions
Quantity funcitons
Webhook functions

Synopsis

data Client
newClient :: Config -> IO Client
data Config = Config {
- endPoint :: Url
- httpManagerSettings :: ManagerSettings
- userName :: UserName
- token :: Token
}
newtype Exception = JsonException String
class FromParameter a where
- fromParameter :: String -> Maybe a
fromParameter' :: FromParameter a => String -> a
class ToParameter a where
- toParameter :: a -> String
type Token = String
type UserName = String
data Agreement
- = Agree
- | Disagree
data Majority
- = Major
- | Minor
type GraphId = String
type GraphName = String
type GraphUnit = String
data GraphType
- = GraphTypeInt
- | GraphTypeFloat
data GraphColor
- = Shibafu
- | Momiji
- | Sora
- | Ichou
- | Ajisai
- | Kuro
type DateFormat = String
data DisplayMode
- = ShortMode
- | DefaultMode
type Url = String
type Date = Day
type Quantity = String
data WebhookType
type WebhookHash = String
createUser :: Agreement -> Majority -> Client -> IO ()
updateToken :: Token -> Client -> IO ()
deleteUser :: Client -> IO ()
createGraph :: GraphId -> GraphName -> GraphUnit -> GraphType -> GraphColor -> Client -> IO ()
getGraphs :: Client -> IO Value
getGraphsBSL :: Client -> IO ByteString
getGraph :: GraphId -> Maybe DateFormat -> DisplayMode -> Client -> IO ByteString
updateGraph :: GraphId -> Maybe GraphName -> Maybe GraphUnit -> Maybe GraphColor -> [Url] -> Client -> IO ()
deleteGraph :: GraphId -> Client -> IO ()
setQuantity :: GraphId -> Date -> Quantity -> Client -> IO ()
getQuantity :: GraphId -> Date -> Client -> IO Value
getQuantityBSL :: GraphId -> Date -> Client -> IO ByteString
updateQuantity :: GraphId -> Date -> Quantity -> Client -> IO ()
incrementQuantity :: GraphId -> Client -> IO ()
decrementQuantity :: GraphId -> Client -> IO ()
deleteQuantity :: GraphId -> Date -> Client -> IO ()
createWebhook :: GraphId -> WebhookType -> Client -> IO Text
getWebhooks :: Client -> IO Value
getWebhooksBSL :: Client -> IO ByteString
invokeWebhook :: WebhookHash -> Client -> IO ()
deleteWebhook :: WebhookHash -> Client -> IO ()

Types

data Client Source #

Pixela client.

import Web.Pixela
import Data.Default (def)

main :: IO
main = do
  _client <- newClient def
  pure ()

newClient :: Config -> IO Client Source #

Create new client.

data Config Source #

Client configuration.

Constructors

Config
Fields endPoint :: Url httpManagerSettings :: ManagerSettings userName :: UserName token :: Token

Instances

Default Config Source #
Instance details Defined in Web.Pixela Methods def :: Config #

newtype Exception Source #

Constructors

JsonException String

Instances

Eq Exception Source #
Instance details Defined in Web.Pixela Methods (==) :: Exception -> Exception -> Bool # (/=) :: Exception -> Exception -> Bool #
Show Exception Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> Exception -> ShowS # show :: Exception -> String # showList :: [Exception] -> ShowS #
Exception Exception Source #
Instance details Defined in Web.Pixela Methods toException :: Exception -> SomeException # fromException :: SomeException -> Maybe Exception # displayException :: Exception -> String #

class FromParameter a where Source #

A type class to create a value from String.

Methods

fromParameter :: String -> Maybe a Source #

If you know this does not fail, you can use fromParameter'.

Instances

FromParameter WebhookType Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe WebhookType Source #
FromParameter DisplayMode Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe DisplayMode Source #
FromParameter GraphColor Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe GraphColor Source #
FromParameter GraphType Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe GraphType Source #

fromParameter' :: FromParameter a => String -> a Source #

Create value from String. This function is unsafe, applys error if fails. fromParameter is safe.

class ToParameter a where Source #

A type class to convert a value to String.

Methods

toParameter :: a -> String Source #

Instances

ToParameter WebhookType Source #
Instance details Defined in Web.Pixela Methods toParameter :: WebhookType -> String Source #
ToParameter DisplayMode Source #
Instance details Defined in Web.Pixela Methods toParameter :: DisplayMode -> String Source #
ToParameter GraphColor Source #
Instance details Defined in Web.Pixela Methods toParameter :: GraphColor -> String Source #
ToParameter GraphType Source #
Instance details Defined in Web.Pixela Methods toParameter :: GraphType -> String Source #

type Token = String Source #

type UserName = String Source #

data Agreement Source #

Which to agree terms of service or not.

Constructors

Agree
Disagree

Instances

Eq Agreement Source #
Instance details Defined in Web.Pixela Methods (==) :: Agreement -> Agreement -> Bool # (/=) :: Agreement -> Agreement -> Bool #
Read Agreement Source #
Instance details Defined in Web.Pixela Methods readsPrec :: Int -> ReadS Agreement # readList :: ReadS [Agreement] # readPrec :: ReadPrec Agreement # readListPrec :: ReadPrec [Agreement] #
Show Agreement Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> Agreement -> ShowS # show :: Agreement -> String # showList :: [Agreement] -> ShowS #

data Majority Source #

Major (adult) or minor (child).

Constructors

Major
Minor

Instances

Eq Majority Source #
Instance details Defined in Web.Pixela Methods (==) :: Majority -> Majority -> Bool # (/=) :: Majority -> Majority -> Bool #
Read Majority Source #
Instance details Defined in Web.Pixela Methods readsPrec :: Int -> ReadS Majority # readList :: ReadS [Majority] # readPrec :: ReadPrec Majority # readListPrec :: ReadPrec [Majority] #
Show Majority Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> Majority -> ShowS # show :: Majority -> String # showList :: [Majority] -> ShowS #

type GraphId = String Source #

type GraphName = String Source #

type GraphUnit = String Source #

data GraphType Source #

Constructors

GraphTypeInt
GraphTypeFloat

Instances

Eq GraphType Source #
Instance details Defined in Web.Pixela Methods (==) :: GraphType -> GraphType -> Bool # (/=) :: GraphType -> GraphType -> Bool #
Read GraphType Source #
Instance details Defined in Web.Pixela Methods readsPrec :: Int -> ReadS GraphType # readList :: ReadS [GraphType] # readPrec :: ReadPrec GraphType # readListPrec :: ReadPrec [GraphType] #
Show GraphType Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> GraphType -> ShowS # show :: GraphType -> String # showList :: [GraphType] -> ShowS #
ToParameter GraphType Source #
Instance details Defined in Web.Pixela Methods toParameter :: GraphType -> String Source #
FromParameter GraphType Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe GraphType Source #

data GraphColor Source #

Constructors

Shibafu	Green
Momiji	Red
Sora	Blue
Ichou	Yellow
Ajisai	Purple
Kuro	Black

Instances

Eq GraphColor Source #
Instance details Defined in Web.Pixela Methods (==) :: GraphColor -> GraphColor -> Bool # (/=) :: GraphColor -> GraphColor -> Bool #
Read GraphColor Source #
Instance details Defined in Web.Pixela Methods readsPrec :: Int -> ReadS GraphColor # readList :: ReadS [GraphColor] # readPrec :: ReadPrec GraphColor # readListPrec :: ReadPrec [GraphColor] #
Show GraphColor Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> GraphColor -> ShowS # show :: GraphColor -> String # showList :: [GraphColor] -> ShowS #
ToParameter GraphColor Source #
Instance details Defined in Web.Pixela Methods toParameter :: GraphColor -> String Source #
FromParameter GraphColor Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe GraphColor Source #

type DateFormat = String Source #

data DisplayMode Source #

Constructors

ShortMode
DefaultMode

Instances

Eq DisplayMode Source #
Instance details Defined in Web.Pixela Methods (==) :: DisplayMode -> DisplayMode -> Bool # (/=) :: DisplayMode -> DisplayMode -> Bool #
Read DisplayMode Source #
Instance details Defined in Web.Pixela Methods readsPrec :: Int -> ReadS DisplayMode # readList :: ReadS [DisplayMode] # readPrec :: ReadPrec DisplayMode # readListPrec :: ReadPrec [DisplayMode] #
Show DisplayMode Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> DisplayMode -> ShowS # show :: DisplayMode -> String # showList :: [DisplayMode] -> ShowS #
ToParameter DisplayMode Source #
Instance details Defined in Web.Pixela Methods toParameter :: DisplayMode -> String Source #
FromParameter DisplayMode Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe DisplayMode Source #

type Url = String Source #

type Date = Day Source #

type Quantity = String Source #

data WebhookType Source #

Instances

Eq WebhookType Source #
Instance details Defined in Web.Pixela Methods (==) :: WebhookType -> WebhookType -> Bool # (/=) :: WebhookType -> WebhookType -> Bool #
Read WebhookType Source #
Instance details Defined in Web.Pixela Methods readsPrec :: Int -> ReadS WebhookType # readList :: ReadS [WebhookType] # readPrec :: ReadPrec WebhookType # readListPrec :: ReadPrec [WebhookType] #
Show WebhookType Source #
Instance details Defined in Web.Pixela Methods showsPrec :: Int -> WebhookType -> ShowS # show :: WebhookType -> String # showList :: [WebhookType] -> ShowS #
ToParameter WebhookType Source #
Instance details Defined in Web.Pixela Methods toParameter :: WebhookType -> String Source #
FromParameter WebhookType Source #
Instance details Defined in Web.Pixela Methods fromParameter :: String -> Maybe WebhookType Source #