serverTypes/index

@prismatic-io/spectral › "serverTypes/index"

Index

Enumerations

• OAuth2Type

Interfaces

• Action
• ActionLogger
• Component
• Connection
• ConnectionValue
• DataSource
• DataSourceContext
• DisplayDefinition
• HttpResponse
• Input
• InputFieldChoice
• ServerPerformBranchingDataReturn
• ServerPerformBranchingDataStructureReturn
• ServerPerformDataReturn
• ServerPerformDataStructureReturn
• Trigger
• TriggerBaseResult
• TriggerBranchingResult
• TriggerPayload

Type aliases

• ActionContext
• ActionLoggerFunction
• ActionPerformFunction
• ActionPerformReturn
• DataSourcePerformFunction
• DataSourceResult
• TriggerEventFunction
• TriggerEventFunctionResult
• TriggerOptionChoice
• TriggerPerformFunction
• TriggerResult

Type aliases

ActionContext

Ƭ ActionContext: object

Defined in packages/spectral/src/serverTypes/index.ts:61

Type declaration:

• configVars: TConfigVars

• crossFlowState: Record‹string, unknown›

• customer: CustomerAttributes

• executionId: string

• executionState: Record‹string, unknown›

• flow: FlowAttributes

• instance: InstanceAttributes

• instanceState: Record‹string, unknown›

• integration: IntegrationAttributes

• integrationState: Record‹string, unknown›

• invokeUrl: string

• logger: ActionLogger

• startedAt: string

• stepId: string

• user: UserAttributes

• webhookApiKeys: Record‹string, string[]›

• webhookUrls: Record‹string, string›

---

ActionLoggerFunction

Ƭ ActionLoggerFunction: function

Defined in packages/spectral/src/serverTypes/index.ts:49

Type declaration:

▸ (...args: unknown[]): void

Parameters:

Name	Type
...args	unknown[]

---

ActionPerformFunction

Ƭ ActionPerformFunction: function

Defined in packages/spectral/src/serverTypes/index.ts:266

Type declaration:

▸ (context: ActionContext, params: Record‹string, unknown›): Promise‹ActionPerformReturn›

Parameters:

Name	Type
context	ActionContext
params	Record‹string, unknown›

---

ActionPerformReturn

Ƭ ActionPerformReturn: ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn | ServerPerformDataReturn | ServerPerformBranchingDataReturn | undefined

Defined in packages/spectral/src/serverTypes/index.ts:259

---

DataSourcePerformFunction

Ƭ DataSourcePerformFunction: function

Defined in packages/spectral/src/serverTypes/index.ts:184

Type declaration:

▸ (context: DataSourceContext, params: Record‹string, unknown›): Promise‹DataSourceResult›

Parameters:

Name	Type
context	DataSourceContext
params	Record‹string, unknown›

---

DataSourceResult

Ƭ DataSourceResult: object

Defined in packages/spectral/src/serverTypes/index.ts:179

Type declaration:

• result: DataSourceResultType

• supplementalData? : undefined | object

---

TriggerEventFunction

Ƭ TriggerEventFunction: function

Defined in packages/spectral/src/serverTypes/index.ts:144

Type declaration:

▸ (context: ActionContext, params: Record‹string, unknown›): Promise‹TriggerEventFunctionResult›

Parameters:

Name	Type
context	ActionContext
params	Record‹string, unknown›

---

TriggerEventFunctionResult

Ƭ TriggerEventFunctionResult: TriggerEventFunctionReturn | void

Defined in packages/spectral/src/serverTypes/index.ts:142

---

TriggerOptionChoice

Ƭ TriggerOptionChoice: "invalid" | "valid" | "required"

Defined in packages/spectral/src/serverTypes/index.ts:83

---

TriggerPerformFunction

Ƭ TriggerPerformFunction: function

Defined in packages/spectral/src/serverTypes/index.ts:136

Type declaration:

▸ (context: ActionContext, payload: TriggerPayload, params: Record‹string, unknown›): Promise‹TriggerResult›

Parameters:

Name	Type
context	ActionContext
payload	TriggerPayload
params	Record‹string, unknown›

---

TriggerResult

Ƭ TriggerResult: TriggerBranchingResult | TriggerBaseResult | undefined

Defined in packages/spectral/src/serverTypes/index.ts:131