Network.PagerDuty.REST

Sending requests

send :: (MonadIO m, FromJSON b) => SubDomain -> Auth s -> Manager -> Request a s b -> m (Either Error b)

See: sendWith

sendWith :: (MonadIO m, FromJSON b) => Env s -> Request a s b -> m (Either Error b)

paginate :: (MonadIO m, Paginate a, FromJSON b) => SubDomain -> Auth s -> Manager -> Request a s b -> Source m (Either Error b)

See: paginateWith

paginateWith :: (MonadIO m, Paginate a, FromJSON b) => Env s -> Request a s b -> Source m (Either Error b)

Configuration

Environment

data Env s

The environment containing the parameters required to make PagerDuty requests.

Instances

Monad m => MonadReader (Env s) (PagerDutyT s m)

Methods

ask :: PagerDutyT s m (Env s)

local :: (Env s -> Env s) -> PagerDutyT s m a -> PagerDutyT s m a

reader :: (Env s -> a) -> PagerDutyT s m a

envDomain :: forall s. Lens' (Env s) SubDomain

envAuth :: forall s s'. Lens (Env s) (Env s') (Auth s) (Auth s')

envManager :: forall s. Lens' (Env s) Manager

envLogger :: forall s. Lens' (Env s) Logger

Logging

data Logger

The log level and associated logger function.

Constructors

None

Debug (Text -> IO ())

debug :: MonadIO m => Logger -> Text -> m ()

Log a message using the debug logger, or if none is specified noop.

Types

Requests

class Paginate a

Exists primarily to obtain a constraint for the paginate function.

Instances

Paginate ListIncidents

Methods

next :: Request ListIncidents s b -> Maybe Pager -> Maybe (Request ListIncidents s b)

Paginate ListServices

Methods

next :: Request ListServices s b -> Maybe Pager -> Maybe (Request ListServices s b)

Paginate ListUsers

Methods

next :: Request ListUsers s b -> Maybe Pager -> Maybe (Request ListUsers s b)

Paginate ListAlerts

Methods

next :: Request ListAlerts s b -> Maybe Pager -> Maybe (Request ListAlerts s b)

Paginate ListPolicies

Methods

next :: Request ListPolicies s b -> Maybe Pager -> Maybe (Request ListPolicies s b)

Paginate ListLogs

Methods

next :: Request ListLogs s b -> Maybe Pager -> Maybe (Request ListLogs s b)

Paginate ListSchedules

Methods

next :: Request ListSchedules s b -> Maybe Pager -> Maybe (Request ListSchedules s b)

data Request a s b

Instances

ToJSON (Request a s b)

Methods

toJSON :: Request a s b -> Value

toEncoding :: Request a s b -> Encoding

toJSONList :: [Request a s b] -> Value

toEncodingList :: [Request a s b] -> Encoding

(QueryLike a, ToJSON a, HasEmailFilterInfo a) => HasEmailFilterInfo (Request a s b)

Methods

emailFilterInfo :: Lens' (Request a s b) EmailFilterInfo

efSubjectMode :: Lens' (Request a s b) (Maybe MatchMode)

efSubjectRegex :: Lens' (Request a s b) (Maybe Text)

efBodyMode :: Lens' (Request a s b) (Maybe MatchMode)

efBodyRegex :: Lens' (Request a s b) (Maybe Text)

efFromEmailMode :: Lens' (Request a s b) (Maybe MatchMode)

efFromEmailRegex :: Lens' (Request a s b) (Maybe Text)

(QueryLike a, ToJSON a, HasUserInfo a) => HasUserInfo (Request a s b)

Methods

userInfo :: Lens' (Request a s b) UserInfo

uId :: Lens' (Request a s b) UserId

uName :: Lens' (Request a s b) Text

uEmail :: Lens' (Request a s b) Address

uColor :: Lens' (Request a s b) Text

uTimeZone :: Lens' (Request a s b) TimeZone

Errors

data Error

Instances

Eq Error

Methods

(==) :: Error -> Error -> Bool

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

Show Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

FromJSON Error

Methods

parseJSON :: Value -> Parser Error

parseJSONList :: Value -> Parser [Error]

HasMessage Error Text

Methods

message :: Lens' Error Text

Monad m => MonadError Error (PagerDutyT s m)

Methods

throwError :: Error -> PagerDutyT s m a

catchError :: PagerDutyT s m a -> (Error -> PagerDutyT s m a) -> PagerDutyT s m a

_Internal :: Prism' Error Text

_Integration :: Prism' Error IntegrationError

_REST :: Prism' Error RESTError

Messages

class HasMessage s a | s -> a where

Minimal complete definition

message

Methods

message :: Lens' s a

A short human-readable message describing the error.

Instances

HasMessage IntegrationError Text

Methods

message :: Lens' IntegrationError Text

HasMessage RESTError Text

Methods

message :: Lens' RESTError Text

HasMessage Error Text

Methods

message :: Lens' Error Text

Fields

class HasErrors s a | s -> a where

Minimal complete definition

errors

Methods

errors :: Lens' s a

A list of human-readable reasons for the error. These values, and even their format, are subject to change.

Instances

HasErrors IntegrationError [Text]

Methods

errors :: Lens' IntegrationError [Text]

HasErrors RESTError [Text]

Methods

errors :: Lens' RESTError [Text]

Integration

data IntegrationError

Instances

Eq IntegrationError

Methods

(==) :: IntegrationError -> IntegrationError -> Bool

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

Show IntegrationError

Methods

showsPrec :: Int -> IntegrationError -> ShowS

show :: IntegrationError -> String

showList :: [IntegrationError] -> ShowS

ToJSON IntegrationError

Methods

toJSON :: IntegrationError -> Value

toEncoding :: IntegrationError -> Encoding

toJSONList :: [IntegrationError] -> Value

toEncodingList :: [IntegrationError] -> Encoding

FromJSON IntegrationError

Methods

parseJSON :: Value -> Parser IntegrationError

parseJSONList :: Value -> Parser [IntegrationError]

HasMessage IntegrationError Text

Methods

message :: Lens' IntegrationError Text

HasErrors IntegrationError [Text]

Methods

errors :: Lens' IntegrationError [Text]

status :: Lens' IntegrationError Text

REST

data RESTError

Instances

Eq RESTError

Methods

(==) :: RESTError -> RESTError -> Bool

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

Show RESTError

Methods

showsPrec :: Int -> RESTError -> ShowS

show :: RESTError -> String

showList :: [RESTError] -> ShowS

ToJSON RESTError

Methods

toJSON :: RESTError -> Value

toEncoding :: RESTError -> Encoding

toJSONList :: [RESTError] -> Value

toEncodingList :: [RESTError] -> Encoding

FromJSON RESTError

Methods

parseJSON :: Value -> Parser RESTError

parseJSONList :: Value -> Parser [RESTError]

HasMessage RESTError Text

Methods

message :: Lens' RESTError Text

HasErrors RESTError [Text]

Methods

errors :: Lens' RESTError [Text]

data Code

Instances

Eq Code

Methods

(==) :: Code -> Code -> Bool

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

Num Code

Methods

(+) :: Code -> Code -> Code

(-) :: Code -> Code -> Code

(*) :: Code -> Code -> Code

negate :: Code -> Code

abs :: Code -> Code

signum :: Code -> Code

fromInteger :: Integer -> Code

Show Code

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

ToJSON Code

Methods

toJSON :: Code -> Value

toEncoding :: Code -> Encoding

toJSONList :: [Code] -> Value

toEncodingList :: [Code] -> Encoding

FromJSON Code

Methods

parseJSON :: Value -> Parser Code

parseJSONList :: Value -> Parser [Code]

code :: Lens' RESTError Code

In the case of an error, the PagerDuty error code can give further details on the nature of the error.

See: description

description :: Code -> Text

Authentication

data Security

Constructors

Basic

Token

Instances

Eq Security

Methods

(==) :: Security -> Security -> Bool

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

Show Security

Methods

showsPrec :: Int -> Security -> ShowS

show :: Security -> String

showList :: [Security] -> ShowS

data Auth a where

Constructors

AuthBasic :: ByteString -> ByteString -> Auth Basic

AuthToken :: ByteString -> Auth Token

Instances

Eq (Auth a)

Methods

(==) :: Auth a -> Auth a -> Bool

(/=) :: Auth a -> Auth a -> Bool

Show (Auth a)

Methods

showsPrec :: Int -> Auth a -> ShowS

show :: Auth a -> String

showList :: [Auth a] -> ShowS

Keys

data Key a

Instances

HasIncidentKey Trigger IncidentKey

Methods

incidentKey :: Lens' Trigger IncidentKey

HasIncidentKey Generic IncidentKey

Methods

incidentKey :: Lens' Generic IncidentKey

HasIncidentKey Event IncidentKey

Methods

incidentKey :: Lens' Event IncidentKey

HasServiceKey Trigger ServiceKey

Methods

serviceKey :: Lens' Trigger ServiceKey

HasServiceKey Generic ServiceKey

Methods

serviceKey :: Lens' Generic ServiceKey

HasServiceKey Event ServiceKey

Methods

serviceKey :: Lens' Event ServiceKey

Eq (Key a)

Methods

(==) :: Key a -> Key a -> Bool

(/=) :: Key a -> Key a -> Bool

Show (Key a)

Methods

showsPrec :: Int -> Key a -> ShowS

show :: Key a -> String

showList :: [Key a] -> ShowS

IsString (Key a)

Methods

fromString :: String -> Key a

ToJSON (Key a)

Methods

toJSON :: Key a -> Value

toEncoding :: Key a -> Encoding

toJSONList :: [Key a] -> Value

toEncodingList :: [Key a] -> Encoding

FromJSON (Key a)

Methods

parseJSON :: Value -> Parser (Key a)

parseJSONList :: Value -> Parser [Key a]

ToByteString (Key a)

Methods

builder :: Key a -> Builder

QueryValueLike (Key a)

Methods

toQueryValue :: Key a -> Maybe ByteString

mkKey :: Text -> Key a

Aliases

type ServiceKey = Key "service"

type IncidentKey = Key "incident"

Identifiers

data Id a

Instances

Eq (Id a)

Methods

(==) :: Id a -> Id a -> Bool

(/=) :: Id a -> Id a -> Bool

Show (Id a)

Methods

showsPrec :: Int -> Id a -> ShowS

show :: Id a -> String

showList :: [Id a] -> ShowS

IsString (Id a)

Methods

fromString :: String -> Id a

ToJSON (Id a)

Methods

toJSON :: Id a -> Value

toEncoding :: Id a -> Encoding

toJSONList :: [Id a] -> Value

toEncodingList :: [Id a] -> Encoding

FromJSON (Id a)

Methods

parseJSON :: Value -> Parser (Id a)

parseJSONList :: Value -> Parser [Id a]

ToByteString (Id a)

Methods

builder :: Id a -> Builder

QueryValueLike (Id a)

Methods

toQueryValue :: Id a -> Maybe ByteString

mkId :: Text -> Id a

Aliases

type AlertId = Id "alert"

type ContactId = Id "contact"

type EmailFilterId = Id "email-filter"

type EscalationPolicyId = Id "escalation-policy"

type EscalationRuleId = Id "escalation-rule"

type IncidentId = Id "incident"

type LogEntryId = Id "log-entry"

type NoteId = Id "note"

type NotificationRuleId = Id "notification-rule"

type OverrideId = Id "schedule-override"

type RequesterId = Id "requester"

type ScheduleId = Id "schedule"

type ServiceId = Id "service"

type UserId = Id "user"

type VendorId = Id "vendor"

type WebhookId = Id "webhook"

type WindowId = Id "maintenance-window"

SubDomain

data SubDomain

Instances

Eq SubDomain

Methods

(==) :: SubDomain -> SubDomain -> Bool

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

Show SubDomain

Methods

showsPrec :: Int -> SubDomain -> ShowS

show :: SubDomain -> String

showList :: [SubDomain] -> ShowS

IsString SubDomain

Methods

fromString :: String -> SubDomain

ToByteString SubDomain

Methods

builder :: SubDomain -> Builder

mkSubDomain :: ByteString -> SubDomain

Address

data Address

Instances

Eq Address

Methods

(==) :: Address -> Address -> Bool

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

Show Address

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

IsString Address

Methods

fromString :: String -> Address

ToJSON Address

Methods

toJSON :: Address -> Value

toEncoding :: Address -> Encoding

toJSONList :: [Address] -> Value

toEncodingList :: [Address] -> Encoding

FromJSON Address

Methods

parseJSON :: Value -> Parser Address

parseJSONList :: Value -> Parser [Address]

ToByteString Address

Methods

builder :: Address -> Builder

mkAddress :: Text -> Address

Miscellaneous

data Empty

Constructors

Empty

Instances

ToJSON Empty

Methods

toJSON :: Empty -> Value

toEncoding :: Empty -> Encoding

toJSONList :: [Empty] -> Value

toEncodingList :: [Empty] -> Encoding

FromJSON Empty

Methods

parseJSON :: Value -> Parser Empty

parseJSONList :: Value -> Parser [Empty]

QueryLike Empty

Methods

toQuery :: Empty -> Query