types/IntegrationDefinition
@prismatic-io/spectral › "types/IntegrationDefinition"
Index
Interfaces
Type aliases
- BaseConfigVar
- CodeLanguageType
- CollectionType
- ComponentSelectorType
- ConfigPage
- ConfigPageElement
- ConfigPages
- ConfigVar
- ConfigVarDataType
- ConnectionConfigVar
- ConnectionDefinitionConfigVar
- ConnectionReferenceConfigVar
- DataSourceConfigVar
- DataSourceDefinitionConfigVar
- DataSourceReferenceConfigVar
- ElementToRuntimeType
- EndpointSecurityType
- EndpointType
- ExtractConfigVars
- GetElements
- IntegrationDefinition
- PreprocessFlowConfig
- RetryConfig
- ScheduleConfigVar
- StandardConfigVar
- StepErrorConfig
- StepErrorHandlerType
- ToComponentReferences
- ToDataSourceRuntimeType
- ValueReference
Functions
- isComponentReference
- isConnectionDefinitionConfigVar
- isConnectionReferenceConfigVar
- isDataSourceDefinitionConfigVar
- isDataSourceReferenceConfigVar
- isScheduleConfigVar
Type aliases
BaseConfigVar
Ƭ BaseConfigVar: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:148
Common attribute shared by all types of Config Vars.
Type declaration:
description? : undefined | string
orgOnly? : undefined | false | true
stableKey: string
visibleToCustomerDeployer? : undefined | false | true
visibleToOrgDeployer? : undefined | false | true
CodeLanguageType
Ƭ CodeLanguageType: "json" | "xml" | "html"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:330
Choices of programming languages that may be used for Config Var code values.
CollectionType
Ƭ CollectionType: "valuelist" | "keyvaluelist"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:333
Choices of collection types for multi-value Config Vars.
ComponentSelectorType
Ƭ ComponentSelectorType: "trigger" | "connection" | "dataSource"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:336
Choices of component reference types.
ConfigPage
Ƭ ConfigPage: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:259
Defines attributes of a Config Wizard Page used when deploying an Instance of an Integration.
Type declaration:
elements: Record‹string, ConfigPageElement‹TComponents››
tagline? : undefined | string
ConfigPageElement
Ƭ ConfigPageElement: string | ConfigVar‹TComponents›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:249
ConfigPages
Ƭ ConfigPages: Record‹string, ConfigPage‹TComponents››
Defined in packages/spectral/src/types/IntegrationDefinition.ts:253
ConfigVar
Ƭ ConfigVar: StandardConfigVar | ScheduleConfigVar | DataSourceConfigVar‹TComponents› | ConnectionConfigVar‹TComponents›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:216
ConfigVarDataType
Ƭ ConfigVarDataType: "string" | "date" | "timestamp" | "picklist" | "schedule" | "code" | "boolean" | "number"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:319
Supported data types for Config Vars.
ConnectionConfigVar
Ƭ ConnectionConfigVar: ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar‹TComponents›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:212
Defines attributes of a Config Var that represents a Connection.
ConnectionDefinitionConfigVar
Ƭ ConnectionDefinitionConfigVar: BaseConfigVar & Omit‹ConnectionDefinition, "label" | "comments" | "key"›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:204
ConnectionReferenceConfigVar
Ƭ ConnectionReferenceConfigVar: BaseConfigVar & object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:206
DataSourceConfigVar
Ƭ DataSourceConfigVar: DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar‹TComponents›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:200
Defines attributes of a data source Config Var.
DataSourceDefinitionConfigVar
Ƭ DataSourceDefinitionConfigVar: BaseConfigVar & Omit‹DataSourceDefinition‹Inputs, ConfigVarResultCollection, DataSourceType›, "display" | "inputs" | "examplePayload"›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:184
DataSourceReferenceConfigVar
Ƭ DataSourceReferenceConfigVar: BaseConfigVar & object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:189
ElementToRuntimeType
Ƭ ElementToRuntimeType: TElement extends ConnectionConfigVar‹any› ? Connection : TElement extends DataSourceConfigVar‹any› ? ToDataSourceRuntimeType‹TElement["dataSourceType"]› : TElement extends ScheduleConfigVar ? Schedule : TElement extends StandardConfigVar ? string : never
Defined in packages/spectral/src/types/IntegrationDefinition.ts:30
EndpointSecurityType
Ƭ EndpointSecurityType: "unsecured" | "customer_optional" | "customer_required" | "organization"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:309
Choices of Endpoint Security Types that may be used by endpoints of a Flow.
EndpointType
Ƭ EndpointType: "flow_specific" | "instance_specific" | "shared_instance"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:303
Choices of Endpoint Types that may be used by Instances of an Integration.
ExtractConfigVars
Ƭ ExtractConfigVars: Prettify‹object›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:46
GetElements
Ƭ GetElements: TConfigPages extends ConfigPages‹any› ? UnionToIntersection‹ValueOf‹TConfigPages›["elements"]› : never
Defined in packages/spectral/src/types/IntegrationDefinition.ts:41
IntegrationDefinition
Ƭ IntegrationDefinition: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:56
Defines attributes of a Code-Native Integration.
Type declaration:
category? : undefined | string
configPages? : TConfigPages
description? : undefined | string
documentation? : undefined | string
endpointType? : EndpointType
flows: Flow‹TConfigPages, TComponents›[]
iconPath? : undefined | string
labels? : string[]
name: string
triggerPreprocessFlowConfig? : PreprocessFlowConfig
version? : undefined | string
PreprocessFlowConfig
Ƭ PreprocessFlowConfig: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:267
Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration.
Type declaration:
externalCustomerIdField? : undefined | string
externalCustomerUserIdField? : undefined | string
flowNameField: string
RetryConfig
Ƭ RetryConfig: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:277
Defines attributes of a Retry Configuration used by a Flow of an Integration.
Type declaration:
delayMinutes: number
maxAttempts: number
uniqueRequestIdField? : undefined | string
usesExponentialBackoff: boolean
ScheduleConfigVar
Ƭ ScheduleConfigVar: BaseConfigVar & object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:175
StandardConfigVar
Ƭ StandardConfigVar: BaseConfigVar & object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:162
Defines attributes of a standard Config Var.
StepErrorConfig
Ƭ StepErrorConfig: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:289
Defines attributes of a Step Error Configuration used to determine how to handle errors during Flow step execution.
Type declaration:
delaySeconds? : undefined | number
errorHandlerType: StepErrorHandlerType
ignoreFinalError? : undefined | false | true
maxAttempts? : undefined | number
usesExponentialBackoff? : undefined | false | true
StepErrorHandlerType
Ƭ StepErrorHandlerType: "fail" | "ignore" | "retry"
Defined in packages/spectral/src/types/IntegrationDefinition.ts:316
Choices of Step Error Handlers that define the behavior when a step error occurs.
ToComponentReferences
Ƭ ToComponentReferences: TComponents extends ComponentSelector‹infer TValueType› ? TComponents["type"] extends TReferenceType ? object : never : never
Defined in packages/spectral/src/types/IntegrationDefinition.ts:355
ToDataSourceRuntimeType
Ƭ ToDataSourceRuntimeType: TType extends "jsonForm" ? JSONForm : TType extends "objectSelection" ? ObjectSelection : TType extends "objectFieldMap" ? ObjectFieldMap : string
Defined in packages/spectral/src/types/IntegrationDefinition.ts:21
ValueReference
Ƭ ValueReference: object
Defined in packages/spectral/src/types/IntegrationDefinition.ts:338
Functions
Const isComponentReference
▸ isComponentReference(ref: unknown): ref is ComponentReference‹any, ConfigPages‹any››
Defined in packages/spectral/src/types/IntegrationDefinition.ts:383
Parameters:
| Name | Type |
|---|---|
ref | unknown |
Returns: ref is ComponentReference‹any, ConfigPages‹any››
Const isConnectionDefinitionConfigVar
▸ isConnectionDefinitionConfigVar(cv: ConfigVar‹any›): cv is ConnectionDefinitionConfigVar
Defined in packages/spectral/src/types/IntegrationDefinition.ts:238
Parameters:
| Name | Type |
|---|---|
cv | ConfigVar‹any› |
Returns: cv is ConnectionDefinitionConfigVar
Const isConnectionReferenceConfigVar
▸ isConnectionReferenceConfigVar‹TComponents›(cv: ConfigVar‹TComponents›): cv is ConnectionReferenceConfigVar‹TComponents›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:242
Type parameters:
▪ TComponents: ComponentSelector‹any›
Parameters:
| Name | Type |
|---|---|
cv | ConfigVar‹TComponents› |
Returns: cv is ConnectionReferenceConfigVar‹TComponents›
Const isDataSourceDefinitionConfigVar
▸ isDataSourceDefinitionConfigVar(cv: ConfigVar‹any›): cv is DataSourceDefinitionConfigVar
Defined in packages/spectral/src/types/IntegrationDefinition.ts:226
Parameters:
| Name | Type |
|---|---|
cv | ConfigVar‹any› |
Returns: cv is DataSourceDefinitionConfigVar
Const isDataSourceReferenceConfigVar
▸ isDataSourceReferenceConfigVar‹TComponents›(cv: ConfigVar‹TComponents›): cv is DataSourceReferenceConfigVar‹TComponents›
Defined in packages/spectral/src/types/IntegrationDefinition.ts:231
Type parameters:
▪ TComponents: ComponentSelector‹any›
Parameters:
| Name | Type |
|---|---|
cv | ConfigVar‹TComponents› |
Returns: cv is DataSourceReferenceConfigVar‹TComponents›
Const isScheduleConfigVar
▸ isScheduleConfigVar(cv: ConfigVar‹any›): cv is ScheduleConfigVar
Defined in packages/spectral/src/types/IntegrationDefinition.ts:222
Parameters:
| Name | Type |
|---|---|
cv | ConfigVar‹any› |
Returns: cv is ScheduleConfigVar