Network.PagerDuty.REST.Users.ContactMethods

Contact methods describe the various channels (phone numbers, SMS numbers and email addresses) used to contact a user when an incident is assigned to the user.

Access and manipulate the contact methods for a user.

See: http://developer.pagerduty.com/documentation/rest/users/contact_methods

List Contacts

listContacts :: UserId -> Request Empty s [Contact]

List existing contact methods for the specified user.

GET /users/:user_id/contact_methods

See: http://developer.pagerduty.com/documentation/rest/users/contact_methods/list

Create Contact

data CreateContact

Instances

Eq CreateContact

Methods

(==) :: CreateContact -> CreateContact -> Bool

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

Show CreateContact

Methods

showsPrec :: Int -> CreateContact -> ShowS

show :: CreateContact -> String

showList :: [CreateContact] -> ShowS

ToJSON CreateContact

Methods

toJSON :: CreateContact -> Value

toEncoding :: CreateContact -> Encoding

toJSONList :: [CreateContact] -> Value

toEncodingList :: [CreateContact] -> Encoding

FromJSON CreateContact

Methods

parseJSON :: Value -> Parser CreateContact

parseJSONList :: Value -> Parser [CreateContact]

QueryLike CreateContact

Methods

toQuery :: CreateContact -> Query

createContact :: UserId -> ContactType -> Address -> Request CreateContact s Contact

Create a new contact method for a given user. A contact method can be one of the following types: SMS, email, and phone. push_notification contact methods cannot be created using this API, they are added automatically during device registration.

POST /users/:user_id/contact_methods

Note: The contact info must be unique.

See: http://developer.pagerduty.com/documentation/rest/users/contact_methods/create

ccType :: Lens' (Request CreateContact s b) ContactType

The type of the contact method.

ccAddress :: Lens' (Request CreateContact s b) Address

The id of the contact method. For SMS and Phone it is the number, and for Email it is the email address.

ccCountryCode :: Lens' (Request CreateContact s b) (Maybe Int)

The number code for your country. Not used for Email.

Default: 1

ccLabel :: Lens' (Request CreateContact s b) (Maybe Text)

A human friendly label for the contact method.

Example: "Home Phone", "Work Email", etc.

Default: The type of the contact method and the address (with country code for phone numbers).

ccSendShortEmail :: Lens' (Request CreateContact s b) (Maybe Bool)

Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers. Only valid for Email contact methods.

Default: false.

Get Contact

getContact :: UserId -> ContactId -> Request Empty s Contact

Get details for a contact method.

GET /users/:user_id/contact_methods/:id

See: http://developer.pagerduty.com/documentation/rest/users/contact_methods/show

Update Contact

data UpdateContact

Instances

Eq UpdateContact

Methods

(==) :: UpdateContact -> UpdateContact -> Bool

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

Show UpdateContact

Methods

showsPrec :: Int -> UpdateContact -> ShowS

show :: UpdateContact -> String

showList :: [UpdateContact] -> ShowS

ToJSON UpdateContact

Methods

toJSON :: UpdateContact -> Value

toEncoding :: UpdateContact -> Encoding

toJSONList :: [UpdateContact] -> Value

toEncodingList :: [UpdateContact] -> Encoding

FromJSON UpdateContact

Methods

parseJSON :: Value -> Parser UpdateContact

parseJSONList :: Value -> Parser [UpdateContact]

QueryLike UpdateContact

Methods

toQuery :: UpdateContact -> Query

updateContact :: UserId -> ContactId -> Request UpdateContact s Contact

Update an existing contact method of a given user. Note that you cannot change the type of an existing method.

PUT /users/:user_id/contact_methods/:id

See: http://developer.pagerduty.com/documentation/rest/users/contact_methods/update

ucAddress :: Lens' (Request UpdateContact s b) (Maybe Address)

The id of the contact method. For SMS and Phone it is the number, and for Email it is the email address.

ucCountryCode :: Lens' (Request UpdateContact s b) (Maybe Int)

The number code for your country. Not used for Email.

Default: 1

ucLabel :: Lens' (Request UpdateContact s b) (Maybe Text)

A human friendly label for the contact method.

Example: "Home Phone", "Work Email", etc.

Default: The type of the contact method and the address (with country code for phone numbers).

ucSendShortEmail :: Lens' (Request UpdateContact s b) (Maybe Bool)

Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers. Only valid for Email contact methods.

Default: false.

Delete Contact

deleteContact :: UserId -> ContactId -> Request Empty s Empty

Remove a contact method and any corresponding notification rules.

DELETE /users/:user_id/contact_methods/:id

See: http://developer.pagerduty.com/documentation/rest/users/contact_methods/delete

Types

data ContactType

Constructors

SMS

Phone

Email

Instances

Eq ContactType

Methods

(==) :: ContactType -> ContactType -> Bool

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

Show ContactType

Methods

showsPrec :: Int -> ContactType -> ShowS

show :: ContactType -> String

showList :: [ContactType] -> ShowS

ToJSON ContactType

Methods

toJSON :: ContactType -> Value

toEncoding :: ContactType -> Encoding

toJSONList :: [ContactType] -> Value

toEncodingList :: [ContactType] -> Encoding

FromJSON ContactType

Methods

parseJSON :: Value -> Parser ContactType

parseJSONList :: Value -> Parser [ContactType]

class HasContact c where

Minimal complete definition

contact

Methods

contact :: Lens' c Contact

cAddress :: Lens' c Address

cBlacklisted :: Lens' c (Maybe Bool')

cCountryCode :: Lens' c (Maybe Int)

cId :: Lens' c ContactId

cLabel :: Lens' c Text

cSendShortEmail :: Lens' c (Maybe Bool')

cType :: Lens' c ContactType

cUserId :: Lens' c UserId

Instances

HasContact Contact

Methods

contact :: Lens' Contact Contact

cAddress :: Lens' Contact Address

cBlacklisted :: Lens' Contact (Maybe Bool')

cCountryCode :: Lens' Contact (Maybe Int)

cId :: Lens' Contact ContactId

cLabel :: Lens' Contact Text

cSendShortEmail :: Lens' Contact (Maybe Bool')

cType :: Lens' Contact ContactType

cUserId :: Lens' Contact UserId

HasContact Rule

Methods

contact :: Lens' Rule Contact

cAddress :: Lens' Rule Address

cBlacklisted :: Lens' Rule (Maybe Bool')

cCountryCode :: Lens' Rule (Maybe Int)

cId :: Lens' Rule ContactId

cLabel :: Lens' Rule Text

cSendShortEmail :: Lens' Rule (Maybe Bool')

cType :: Lens' Rule ContactType

cUserId :: Lens' Rule UserId

data Contact

Instances

Eq Contact

Methods

(==) :: Contact -> Contact -> Bool

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

Show Contact

Methods

showsPrec :: Int -> Contact -> ShowS

show :: Contact -> String

showList :: [Contact] -> ShowS

ToJSON Contact

Methods

toJSON :: Contact -> Value

toEncoding :: Contact -> Encoding

toJSONList :: [Contact] -> Value

toEncodingList :: [Contact] -> Encoding

FromJSON Contact

Methods

parseJSON :: Value -> Parser Contact

parseJSONList :: Value -> Parser [Contact]

HasContact Contact

Methods

contact :: Lens' Contact Contact

cAddress :: Lens' Contact Address

cBlacklisted :: Lens' Contact (Maybe Bool')

cCountryCode :: Lens' Contact (Maybe Int)

cId :: Lens' Contact ContactId

cLabel :: Lens' Contact Text

cSendShortEmail :: Lens' Contact (Maybe Bool')

cType :: Lens' Contact ContactType

cUserId :: Lens' Contact UserId