Web.Pixela

Types

data Client

Pixela client.

import Web.Pixela
import Data.Default (def)

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

newClient :: Config -> IO Client

Create new client.

data Config

Client configuration.

Constructors

Config

Fields

• endPoint :: Url
• httpManagerSettings :: ManagerSettings
• userName :: UserName
• token :: Token

Instances

Default Config

Defined in Web.Pixela

Methods

def :: Config

newtype Exception

Constructors

JsonException String

Instances

Eq Exception

Defined in Web.Pixela

Methods

(==) :: Exception -> Exception -> Bool

(/=) :: Exception -> Exception -> Bool

Show Exception

Defined in Web.Pixela

Methods

showsPrec :: Int -> Exception -> ShowS

show :: Exception -> String

showList :: [Exception] -> ShowS

Exception Exception

Defined in Web.Pixela

Methods

toException :: Exception -> SomeException

fromException :: SomeException -> Maybe Exception

displayException :: Exception -> String

class FromParameter a where

A type class to create a value from String.

Methods

fromParameter :: String -> Maybe a

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

Instances

FromParameter WebhookType

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe WebhookType

FromParameter DisplayMode

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe DisplayMode

FromParameter GraphColor

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe GraphColor

FromParameter GraphType

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe GraphType

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

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

class ToParameter a where

A type class to convert a value to String.

Methods

toParameter :: a -> String

Instances

ToParameter WebhookType

Defined in Web.Pixela

Methods

toParameter :: WebhookType -> String

ToParameter DisplayMode

Defined in Web.Pixela

Methods

toParameter :: DisplayMode -> String

ToParameter GraphColor

Defined in Web.Pixela

Methods

toParameter :: GraphColor -> String

ToParameter GraphType

Defined in Web.Pixela

Methods

toParameter :: GraphType -> String

type Token = String

type UserName = String

data Agreement

Which to agree terms of service or not.

Constructors

Agree

Disagree

Instances

Eq Agreement

Defined in Web.Pixela

Methods

(==) :: Agreement -> Agreement -> Bool

(/=) :: Agreement -> Agreement -> Bool

Read Agreement

Defined in Web.Pixela

Methods

readsPrec :: Int -> ReadS Agreement

readList :: ReadS [Agreement]

readPrec :: ReadPrec Agreement

readListPrec :: ReadPrec [Agreement]

Show Agreement

Defined in Web.Pixela

Methods

showsPrec :: Int -> Agreement -> ShowS

show :: Agreement -> String

showList :: [Agreement] -> ShowS

data Majority

Major (adult) or minor (child).

Constructors

Major

Minor

Instances

Eq Majority

Defined in Web.Pixela

Methods

(==) :: Majority -> Majority -> Bool

(/=) :: Majority -> Majority -> Bool

Read Majority

Defined in Web.Pixela

Methods

readsPrec :: Int -> ReadS Majority

readList :: ReadS [Majority]

readPrec :: ReadPrec Majority

readListPrec :: ReadPrec [Majority]

Show Majority

Defined in Web.Pixela

Methods

showsPrec :: Int -> Majority -> ShowS

show :: Majority -> String

showList :: [Majority] -> ShowS

type GraphId = String

type GraphName = String

type GraphUnit = String

data GraphType

Constructors

GraphTypeInt

GraphTypeFloat

Instances

Eq GraphType

Defined in Web.Pixela

Methods

(==) :: GraphType -> GraphType -> Bool

(/=) :: GraphType -> GraphType -> Bool

Read GraphType

Defined in Web.Pixela

Methods

readsPrec :: Int -> ReadS GraphType

readList :: ReadS [GraphType]

readPrec :: ReadPrec GraphType

readListPrec :: ReadPrec [GraphType]

Show GraphType

Defined in Web.Pixela

Methods

showsPrec :: Int -> GraphType -> ShowS

show :: GraphType -> String

showList :: [GraphType] -> ShowS

ToParameter GraphType

Defined in Web.Pixela

Methods

toParameter :: GraphType -> String

FromParameter GraphType

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe GraphType

data GraphColor

Constructors

Shibafu

Green

Momiji

Red

Sora

Blue

Ichou

Yellow

Ajisai

Purple

Kuro

Black

Instances

Eq GraphColor

Defined in Web.Pixela

Methods

(==) :: GraphColor -> GraphColor -> Bool

(/=) :: GraphColor -> GraphColor -> Bool

Read GraphColor

Defined in Web.Pixela

Methods

readsPrec :: Int -> ReadS GraphColor

readList :: ReadS [GraphColor]

readPrec :: ReadPrec GraphColor

readListPrec :: ReadPrec [GraphColor]

Show GraphColor

Defined in Web.Pixela

Methods

showsPrec :: Int -> GraphColor -> ShowS

show :: GraphColor -> String

showList :: [GraphColor] -> ShowS

ToParameter GraphColor

Defined in Web.Pixela

Methods

toParameter :: GraphColor -> String

FromParameter GraphColor

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe GraphColor

type DateFormat = String

data DisplayMode

Constructors

ShortMode

DefaultMode

Instances

Eq DisplayMode

Defined in Web.Pixela

Methods

(==) :: DisplayMode -> DisplayMode -> Bool

(/=) :: DisplayMode -> DisplayMode -> Bool

Read DisplayMode

Defined in Web.Pixela

Methods

readsPrec :: Int -> ReadS DisplayMode

readList :: ReadS [DisplayMode]

readPrec :: ReadPrec DisplayMode

readListPrec :: ReadPrec [DisplayMode]

Show DisplayMode

Defined in Web.Pixela

Methods

showsPrec :: Int -> DisplayMode -> ShowS

show :: DisplayMode -> String

showList :: [DisplayMode] -> ShowS

ToParameter DisplayMode

Defined in Web.Pixela

Methods

toParameter :: DisplayMode -> String

FromParameter DisplayMode

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe DisplayMode

type Url = String

type Date = Day

type Quantity = String

data WebhookType

Instances

Eq WebhookType

Defined in Web.Pixela

Methods

(==) :: WebhookType -> WebhookType -> Bool

(/=) :: WebhookType -> WebhookType -> Bool

Read WebhookType

Defined in Web.Pixela

Methods

readsPrec :: Int -> ReadS WebhookType

readList :: ReadS [WebhookType]

readPrec :: ReadPrec WebhookType

readListPrec :: ReadPrec [WebhookType]

Show WebhookType

Defined in Web.Pixela

Methods

showsPrec :: Int -> WebhookType -> ShowS

show :: WebhookType -> String

showList :: [WebhookType] -> ShowS

ToParameter WebhookType

Defined in Web.Pixela

Methods

toParameter :: WebhookType -> String

FromParameter WebhookType

Defined in Web.Pixela

Methods

fromParameter :: String -> Maybe WebhookType

type WebhookHash = String

User functions

createUser :: Agreement -> Majority -> Client -> IO ()

Create a user. https://pixe.la/#api-detail-post-users

updateToken :: Token -> Client -> IO ()

Update user token. https://pixe.la/#api-detail-put-user

deleteUser :: Client -> IO ()

Delete the user. https://pixe.la/#api-detail-delete-user

Graph functions

createGraph :: GraphId -> GraphName -> GraphUnit -> GraphType -> GraphColor -> Client -> IO ()

Create a graph. https://pixe.la/#api-detail-post-graphs

getGraphs :: Client -> IO Value

Get the list of infomation of graphs. https://pixe.la/#api-detail-get-graphs

getGraphsBSL :: Client -> IO ByteString

Get the list of infomation of graphs. https://pixe.la/#api-detail-get-graphs

getGraph :: GraphId -> Maybe DateFormat -> DisplayMode -> Client -> IO ByteString

Get the graph. https://pixe.la/#api-detail-get-graph

updateGraph :: GraphId -> Maybe GraphName -> Maybe GraphUnit -> Maybe GraphColor -> [Url] -> Client -> IO ()

Update the graph. https://pixe.la/#api-detail-put-graph

deleteGraph :: GraphId -> Client -> IO ()

Delete the graph. https://pixe.la/#api-detail-delete-graph

Quantity funcitons

setQuantity :: GraphId -> Date -> Quantity -> Client -> IO ()

Set quantity pixel. https://pixe.la/#api-detail-post-pixels

getQuantity :: GraphId -> Date -> Client -> IO Value

Get quantity pixel. https://pixe.la/#api-detail-get-pixel

getQuantityBSL :: GraphId -> Date -> Client -> IO ByteString

Get quantity pixel. https://pixe.la/#api-detail-get-pixel

updateQuantity :: GraphId -> Date -> Quantity -> Client -> IO ()

Update quantity pixel. https://pixe.la/#api-detail-put-pixel

incrementQuantity :: GraphId -> Client -> IO ()

Increment quantity pixel. https://pixe.la/#api-detail-pixel-increment

decrementQuantity :: GraphId -> Client -> IO ()

Decrement quantity pixel. https://pixe.la/#api-detail-pixel-decrement

deleteQuantity :: GraphId -> Date -> Client -> IO ()

Delete quantity pixel. https://pixe.la/#api-detail-delete-pixel

Webhook functions

createWebhook :: GraphId -> WebhookType -> Client -> IO Text

Create a webhook. https://pixe.la/#api-detail-post-webhooks

getWebhooks :: Client -> IO Value

Get the webhook. https://pixe.la/#api-detail-get-webhooks

getWebhooksBSL :: Client -> IO ByteString

Get the webhook. https://pixe.la/#api-detail-get-webhooks

invokeWebhook :: WebhookHash -> Client -> IO ()

Invoke the webhook. https://pixe.la/#api-detail-post-webhook

deleteWebhook :: WebhookHash -> Client -> IO ()

Delete the webhook. https://pixe.la/#api-detail-delete-webhook