Safe Haskell	None
Language	Haskell2010

Hasura.RQL.Types.Eventing

Description

This module contains types which are common to event triggers and scheduled triggers.

Synopsis

newtype EventId = EventId {
- unEventId :: Text
}
data TriggerTypes
- = EventType
- | ScheduledType
data WebhookRequest = WebhookRequest {
- _rqPayload :: Value
- _rqHeaders :: [HeaderConf]
- _rqVersion :: Text
}
data WebhookResponse = WebhookResponse {
- _wrsBody :: SerializableBlob
- _wrsHeaders :: [HeaderConf]
- _wrsStatus :: Int
}
newtype ClientError = ClientError {
- _ceMessage :: SerializableBlob
}
data Response (a :: TriggerTypes)
- = ResponseHTTP WebhookResponse
- | ResponseError ClientError
type InvocationVersion = Text
invocationVersionET :: InvocationVersion
invocationVersionST :: InvocationVersion
data Invocation (a :: TriggerTypes) = Invocation {
- iEventId :: EventId
- iStatus :: Maybe Int
- iRequest :: WebhookRequest
- iResponse :: Response a
}
newtype PGTextArray = PGTextArray {
- unPGTextArray :: [Text]
}
data OpVar
- = OLD
- | NEW

Documentation

newtype EventId Source #

Constructors

EventId
Fields unEventId :: Text

Instances

Instances details

Eq EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods (==) :: EventId -> EventId -> Bool # (/=) :: EventId -> EventId -> Bool #
Ord EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods compare :: EventId -> EventId -> Ordering # (<) :: EventId -> EventId -> Bool # (<=) :: EventId -> EventId -> Bool # (>) :: EventId -> EventId -> Bool # (>=) :: EventId -> EventId -> Bool # max :: EventId -> EventId -> EventId # min :: EventId -> EventId -> EventId #
Show EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods showsPrec :: Int -> EventId -> ShowS # show :: EventId -> String # showList :: [EventId] -> ShowS #
Generic EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Associated Types type Rep EventId :: Type -> Type # Methods from :: EventId -> Rep EventId x # to :: Rep EventId x -> EventId #
NFData EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods rnf :: EventId -> () #
Hashable EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods hashWithSalt :: Int -> EventId -> Int hash :: EventId -> Int
FromJSON EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods parseJSON :: Value -> Parser EventId parseJSONList :: Value -> Parser [EventId]
ToJSONKey EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSONKey :: ToJSONKeyFunction EventId toJSONKeyList :: ToJSONKeyFunction [EventId]
ToJSON EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: EventId -> Value toEncoding :: EventId -> Encoding toJSONList :: [EventId] -> Value toEncodingList :: [EventId] -> Encoding
ToTxt EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toTxt :: EventId -> Text Source #
FromCol EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods fromCol :: Maybe ByteString -> Either Text EventId
ToPrepArg EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toPrepVal :: EventId -> PrepArg
Cacheable EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods unchanged :: Accesses -> EventId -> EventId -> Bool Source #
type Rep EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing type Rep EventId = D1 ('MetaData "EventId" "Hasura.RQL.Types.Eventing" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "EventId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data TriggerTypes Source #

There are two types of events: EventType (for event triggers) and ScheduledType (for scheduled triggers)

Constructors

EventType
ScheduledType

data WebhookRequest Source #

Constructors

WebhookRequest
Fields _rqPayload :: Value _rqHeaders :: [HeaderConf] _rqVersion :: Text

Instances

Instances details

ToJSON WebhookRequest Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: WebhookRequest -> Value toEncoding :: WebhookRequest -> Encoding toJSONList :: [WebhookRequest] -> Value toEncodingList :: [WebhookRequest] -> Encoding

data WebhookResponse Source #

Constructors

WebhookResponse
Fields _wrsBody :: SerializableBlob _wrsHeaders :: [HeaderConf] _wrsStatus :: Int

Instances

Instances details

ToJSON WebhookResponse Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: WebhookResponse -> Value toEncoding :: WebhookResponse -> Encoding toJSONList :: [WebhookResponse] -> Value toEncodingList :: [WebhookResponse] -> Encoding

newtype ClientError Source #

Constructors

ClientError
Fields _ceMessage :: SerializableBlob

Instances

Instances details

ToJSON ClientError Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: ClientError -> Value toEncoding :: ClientError -> Encoding toJSONList :: [ClientError] -> Value toEncodingList :: [ClientError] -> Encoding

data Response (a :: TriggerTypes) Source #

Constructors

ResponseHTTP WebhookResponse
ResponseError ClientError

Instances

Instances details

ToJSON (Response 'EventType) Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: Response 'EventType -> Value toEncoding :: Response 'EventType -> Encoding toJSONList :: [Response 'EventType] -> Value toEncodingList :: [Response 'EventType] -> Encoding
ToJSON (Response 'ScheduledType) Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: Response 'ScheduledType -> Value toEncoding :: Response 'ScheduledType -> Encoding toJSONList :: [Response 'ScheduledType] -> Value toEncodingList :: [Response 'ScheduledType] -> Encoding

type InvocationVersion = Text Source #

invocationVersionET :: InvocationVersion Source #

invocationVersionST :: InvocationVersion Source #

data Invocation (a :: TriggerTypes) Source #

Constructors

Invocation
Fields iEventId :: EventId iStatus :: Maybe Int iRequest :: WebhookRequest iResponse :: Response a

newtype PGTextArray Source #

PGTextArray is only used for PG array encoding

Constructors

PGTextArray
Fields unPGTextArray :: [Text]

Instances

Instances details

Eq PGTextArray Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods (==) :: PGTextArray -> PGTextArray -> Bool # (/=) :: PGTextArray -> PGTextArray -> Bool #
Show PGTextArray Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods showsPrec :: Int -> PGTextArray -> ShowS # show :: PGTextArray -> String # showList :: [PGTextArray] -> ShowS #
ToPrepArg PGTextArray Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toPrepVal :: PGTextArray -> PrepArg

data OpVar Source #

Used to construct the payload of Event Trigger

OLD: Depicts the old database row value for UPDATE/DELETE trigger operations. This is used to construct the 'data.old' field of the event trigger payload. The value of 'data.old' is null in INSERT trigger operation.

NEW: Depicts the new database row value for INSERT/UPDATE trigger operations. This is used to construct the 'data.new' field of the event trigger payload. The value of 'data.new' is null in DELETE trigger operation.

Constructors

OLD
NEW

Instances

Instances details

Show OpVar Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods showsPrec :: Int -> OpVar -> ShowS # show :: OpVar -> String # showList :: [OpVar] -> ShowS #