Safe Haskell	Safe-Inferred
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

FromJSON EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods parseJSON :: Value -> Parser EventId Source # parseJSONList :: Value -> Parser [EventId] Source #
ToJSON EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSON :: EventId -> Value Source # toEncoding :: EventId -> Encoding Source # toJSONList :: [EventId] -> Value Source # toEncodingList :: [EventId] -> Encoding Source #
ToJSONKey EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toJSONKey :: ToJSONKeyFunction EventId Source # toJSONKeyList :: ToJSONKeyFunction [EventId] Source #
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 #
Show EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods showsPrec :: Int -> EventId -> ShowS # show :: EventId -> String # showList :: [EventId] -> ShowS #
NFData EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods rnf :: EventId -> () #
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 #
Hashable EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods hashWithSalt :: Int -> EventId -> Int Source # hash :: EventId -> Int Source #
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 Source #
ToPrepArg EventId Source #
Instance details Defined in Hasura.RQL.Types.Eventing Methods toPrepVal :: EventId -> PrepArg 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 Source # toEncoding :: WebhookRequest -> Encoding Source # toJSONList :: [WebhookRequest] -> Value Source # toEncodingList :: [WebhookRequest] -> Encoding Source #
Generic WebhookRequest Source #
Instance details Defined in Hasura.RQL.Types.Eventing Associated Types type Rep WebhookRequest :: Type -> Type # Methods from :: WebhookRequest -> Rep WebhookRequest x # to :: Rep WebhookRequest x -> WebhookRequest #
type Rep WebhookRequest Source #
Instance details Defined in Hasura.RQL.Types.Eventing type Rep WebhookRequest = D1 ('MetaData "WebhookRequest" "Hasura.RQL.Types.Eventing" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "WebhookRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rqPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value) :: (S1 ('MetaSel ('Just "_rqHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HeaderConf]) :: S1 ('MetaSel ('Just "_rqVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

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 Source # toEncoding :: WebhookResponse -> Encoding Source # toJSONList :: [WebhookResponse] -> Value Source # toEncodingList :: [WebhookResponse] -> Encoding Source #
Generic WebhookResponse Source #
Instance details Defined in Hasura.RQL.Types.Eventing Associated Types type Rep WebhookResponse :: Type -> Type # Methods from :: WebhookResponse -> Rep WebhookResponse x # to :: Rep WebhookResponse x -> WebhookResponse #
type Rep WebhookResponse Source #
Instance details Defined in Hasura.RQL.Types.Eventing type Rep WebhookResponse = D1 ('MetaData "WebhookResponse" "Hasura.RQL.Types.Eventing" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "WebhookResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "_wrsBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SerializableBlob) :: (S1 ('MetaSel ('Just "_wrsHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HeaderConf]) :: S1 ('MetaSel ('Just "_wrsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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 Source # toEncoding :: ClientError -> Encoding Source # toJSONList :: [ClientError] -> Value Source # toEncodingList :: [ClientError] -> Encoding Source #
Generic ClientError Source #
Instance details Defined in Hasura.RQL.Types.Eventing Associated Types type Rep ClientError :: Type -> Type # Methods from :: ClientError -> Rep ClientError x # to :: Rep ClientError x -> ClientError #
type Rep ClientError Source #
Instance details Defined in Hasura.RQL.Types.Eventing type Rep ClientError = D1 ('MetaData "ClientError" "Hasura.RQL.Types.Eventing" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "ClientError" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ceMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SerializableBlob)))

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

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

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

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 #