Safe Haskell	Safe-Inferred
Language	Haskell2010

MSGraphAPI.ChangeNotifications.Subscription

Description

Subscription to change notifications through webhooks

see https://learn.microsoft.com/en-us/graph/webhooks#supported-resources for a list of resources that can produce change notifications

see https://learn.microsoft.com/en-us/graph/change-notifications-delivery-webhooks?tabs=http for protocol details

Synopsis

data ChangeNotification a = ChangeNotification {
- cnChangeType :: ChangeType
- cnClientState :: Text
- cnId :: Text
- cnResource :: Text
- cnResourceData :: Maybe a
- cnSubscriptionId :: Text
- cnTenantId :: Text
}
createSubscription :: FromJSON b => Subscription -> AccessToken -> Req b
data Subscription = Subscription {
- cnsId :: Text
- cnsChangeType :: NonEmpty ChangeType
- cnsClientState :: Text
- cnsExpirationDateTime :: LocalTime
- cnsNotificationUrl :: Text
- cnsResource :: Text
- cnsLatestSupportedTLSVersion :: LatestTLSVer
}
data LatestTLSVer
- = LTV10
- | LTV11
- | LTV12
- | LTV13
data ChangeType
- = CTCreated
- | CTUpdated
- | CTDeleted

Documentation

data ChangeNotification a Source #

Represents the notification sent to the subscriber. https://learn.microsoft.com/en-us/graph/api/resources/changenotification?view=graph-rest-1.0

Constructors

ChangeNotification
Fields cnChangeType :: ChangeType cnClientState :: Text cnId :: Text cnResource :: Text cnResourceData :: Maybe a cnSubscriptionId :: Text cnTenantId :: Text

Instances

Instances details

FromJSON a => FromJSON (ChangeNotification a) Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods parseJSON :: Value -> Parser (ChangeNotification a) # parseJSONList :: Value -> Parser [ChangeNotification a] #
Generic (ChangeNotification a) Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Associated Types type Rep (ChangeNotification a) :: Type -> Type # Methods from :: ChangeNotification a -> Rep (ChangeNotification a) x # to :: Rep (ChangeNotification a) x -> ChangeNotification a #
Show a => Show (ChangeNotification a) Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods showsPrec :: Int -> ChangeNotification a -> ShowS # show :: ChangeNotification a -> String # showList :: [ChangeNotification a] -> ShowS #
Eq a => Eq (ChangeNotification a) Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods (==) :: ChangeNotification a -> ChangeNotification a -> Bool # (/=) :: ChangeNotification a -> ChangeNotification a -> Bool #
type Rep (ChangeNotification a) Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription type Rep (ChangeNotification a) = D1 ('MetaData "ChangeNotification" "MSGraphAPI.ChangeNotifications.Subscription" "ms-graph-api-0.8.0.0-1Hc87tdNmGcmk9g3yH9mp" 'False) (C1 ('MetaCons "ChangeNotification" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cnChangeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChangeType) :: (S1 ('MetaSel ('Just "cnClientState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "cnId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "cnResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "cnResourceData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))) :: (S1 ('MetaSel ('Just "cnSubscriptionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "cnTenantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

createSubscription :: FromJSON b => Subscription -> AccessToken -> Req b Source #

Create a subscription https://learn.microsoft.com/en-us/graph/api/subscription-post-subscriptions?view=graph-rest-1.0&tabs=http

 POST https://graph.microsoft.com/v1.0/subscriptions

Creating a subscription requires read scope to the resource. For example, to get change notifications on messages, your app needs the Mail.Read permission.

data Subscription Source #

A subscription allows a client app to receive change notifications about changes to data in Microsoft Graph.

https://learn.microsoft.com/en-us/graph/api/resources/subscription?view=graph-rest-1.0

Constructors

Subscription

Fields

cnsId :: Text
cnsChangeType :: NonEmpty ChangeType
cnsClientState :: Text
cnsExpirationDateTime :: LocalTime
cnsNotificationUrl :: Text
The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property will be included in the HTTP POST request when Microsoft Graph sends the change notifications.
cnsResource :: Text
Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/)
cnsLatestSupportedTLSVersion :: LatestTLSVer

Instances

Instances details

FromJSON Subscription Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods parseJSON :: Value -> Parser Subscription # parseJSONList :: Value -> Parser [Subscription] #
ToJSON Subscription Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods toJSON :: Subscription -> Value # toEncoding :: Subscription -> Encoding # toJSONList :: [Subscription] -> Value # toEncodingList :: [Subscription] -> Encoding #
Generic Subscription Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Associated Types type Rep Subscription :: Type -> Type # Methods from :: Subscription -> Rep Subscription x # to :: Rep Subscription x -> Subscription #
Show Subscription Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods showsPrec :: Int -> Subscription -> ShowS # show :: Subscription -> String # showList :: [Subscription] -> ShowS #
Eq Subscription Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods (==) :: Subscription -> Subscription -> Bool # (/=) :: Subscription -> Subscription -> Bool #
type Rep Subscription Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription type Rep Subscription = D1 ('MetaData "Subscription" "MSGraphAPI.ChangeNotifications.Subscription" "ms-graph-api-0.8.0.0-1Hc87tdNmGcmk9g3yH9mp" 'False) (C1 ('MetaCons "Subscription" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cnsId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "cnsChangeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty ChangeType)) :: S1 ('MetaSel ('Just "cnsClientState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "cnsExpirationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalTime) :: S1 ('MetaSel ('Just "cnsNotificationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "cnsResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "cnsLatestSupportedTLSVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LatestTLSVer)))))

data LatestTLSVer Source #

Constructors

LTV10
LTV11
LTV12
LTV13

Instances

Instances details

FromJSON LatestTLSVer Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods parseJSON :: Value -> Parser LatestTLSVer # parseJSONList :: Value -> Parser [LatestTLSVer] #
ToJSON LatestTLSVer Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods toJSON :: LatestTLSVer -> Value # toEncoding :: LatestTLSVer -> Encoding # toJSONList :: [LatestTLSVer] -> Value # toEncodingList :: [LatestTLSVer] -> Encoding #
Generic LatestTLSVer Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Associated Types type Rep LatestTLSVer :: Type -> Type # Methods from :: LatestTLSVer -> Rep LatestTLSVer x # to :: Rep LatestTLSVer x -> LatestTLSVer #
Show LatestTLSVer Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods showsPrec :: Int -> LatestTLSVer -> ShowS # show :: LatestTLSVer -> String # showList :: [LatestTLSVer] -> ShowS #
Eq LatestTLSVer Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods (==) :: LatestTLSVer -> LatestTLSVer -> Bool # (/=) :: LatestTLSVer -> LatestTLSVer -> Bool #
type Rep LatestTLSVer Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription type Rep LatestTLSVer = D1 ('MetaData "LatestTLSVer" "MSGraphAPI.ChangeNotifications.Subscription" "ms-graph-api-0.8.0.0-1Hc87tdNmGcmk9g3yH9mp" 'False) ((C1 ('MetaCons "LTV10" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LTV11" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LTV12" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LTV13" 'PrefixI 'False) (U1 :: Type -> Type)))

data ChangeType Source #

Constructors

CTCreated
CTUpdated
CTDeleted

Instances

Instances details

FromJSON ChangeType Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods parseJSON :: Value -> Parser ChangeType # parseJSONList :: Value -> Parser [ChangeType] #
ToJSON ChangeType Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods toJSON :: ChangeType -> Value # toEncoding :: ChangeType -> Encoding # toJSONList :: [ChangeType] -> Value # toEncodingList :: [ChangeType] -> Encoding #
Generic ChangeType Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Associated Types type Rep ChangeType :: Type -> Type # Methods from :: ChangeType -> Rep ChangeType x # to :: Rep ChangeType x -> ChangeType #
Show ChangeType Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods showsPrec :: Int -> ChangeType -> ShowS # show :: ChangeType -> String # showList :: [ChangeType] -> ShowS #
Eq ChangeType Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription Methods (==) :: ChangeType -> ChangeType -> Bool # (/=) :: ChangeType -> ChangeType -> Bool #
type Rep ChangeType Source #
Instance details Defined in MSGraphAPI.ChangeNotifications.Subscription type Rep ChangeType = D1 ('MetaData "ChangeType" "MSGraphAPI.ChangeNotifications.Subscription" "ms-graph-api-0.8.0.0-1Hc87tdNmGcmk9g3yH9mp" 'False) (C1 ('MetaCons "CTCreated" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CTUpdated" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CTDeleted" 'PrefixI 'False) (U1 :: Type -> Type)))