Membrane SDK - v0.8.0
Console
React Lib
REST API
Preparing search index...
FlowInstanceAccessor
Class FlowInstanceAccessor
Hierarchy (
View Summary
)
ElementInstanceAccessor
<
FlowInstance
,
FlowInstanceSelector
,
CreateFlowInstanceRequest
,
UpdateFlowInstanceRequest
,
>
FlowInstanceAccessor
Index
Constructors
constructor
Properties
options
client
selector
Methods
get
Unique
Identifier
get
get
Id
create
put
patch
archive
delete
restore
get
Path
enable
disable
update
To
Latest
Flow
setup
reset
open
Configuration
open
Editor
embed
Editor
start
Run
run
Constructors
constructor
new
FlowInstanceAccessor
(
client
:
MembraneApiClient
,
selector
:
string
|
FlowInstanceSelector
,
)
:
FlowInstanceAccessor
Parameters
client
:
MembraneApiClient
selector
:
string
|
FlowInstanceSelector
Returns
FlowInstanceAccessor
Properties
Protected
options
options
:
{
client
:
MembraneApiClient
;
instancePath
:
string
;
selector
:
string
|
FlowInstanceSelector
;
type
?:
WorkspaceElementType
;
}
Protected
client
client
:
MembraneApiClient
Protected
selector
selector
:
string
|
FlowInstanceSelector
Methods
get
Unique
Identifier
getUniqueIdentifier
()
:
string
Returns
string
get
get
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
get
Id
getId
()
:
Promise
<
string
>
Returns
Promise
<
string
>
create
create
(
data
?:
{
name
?:
string
;
userId
?:
string
;
flowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"continue"
|
"stop"
;
concurrency
?:
number
;
ui
?:
any
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
Optional
data
:
{
name
?:
string
;
userId
?:
string
;
flowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"continue"
|
"stop"
;
concurrency
?:
number
;
ui
?:
any
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
put
put
(
data
:
{
name
?:
string
;
userId
?:
string
;
flowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"continue"
|
"stop"
;
concurrency
?:
number
;
ui
?:
any
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
data
:
{
name
?:
string
;
userId
?:
string
;
flowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"continue"
|
"stop"
;
concurrency
?:
number
;
ui
?:
any
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
enabled
?:
boolean
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
patch
patch
(
data
:
{
name
?:
string
;
enabled
?:
boolean
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"continue"
|
"stop"
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
concurrency
?:
number
;
isCustomized
?:
boolean
;
}
,
>
;
archivedAt
?:
string
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
data
:
{
name
?:
string
;
enabled
?:
boolean
;
parameters
?:
any
;
nodes
?:
Record
<
string
,
{
name
?:
string
;
type
?:
string
;
userConfig
?:
any
;
config
?:
any
;
onError
?:
"continue"
|
"stop"
;
links
?:
{
key
?:
string
;
filter
?:
any
;
name
?:
string
}
[]
;
concurrency
?:
number
;
isCustomized
?:
boolean
;
}
,
>
;
archivedAt
?:
string
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
}
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
archive
archive
()
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
delete
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Deprecated
use
archive
instead
restore
restore
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Protected
get
Path
getPath
(
operation
?:
string
)
:
string
Parameters
operation
:
string
= ''
Returns
string
enable
enable
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
disable
disable
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
update
To
Latest
Flow
updateToLatestFlow
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
setup
setup
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
reset
reset
(
options
?:
{
name
?:
boolean
;
nodes
?:
Record
<
string
,
boolean
>
;
allNodes
?:
boolean
;
}
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
Optional
options
:
{
name
?:
boolean
;
nodes
?:
Record
<
string
,
boolean
>
;
allNodes
?:
boolean
}
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
flow
?:
{
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
universalFlowId
?:
string
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
dependencies
?:
any
[]
;
integrationId
?:
string
;
universalFlowId
?:
string
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
{
type
?:
string
;
version
?:
number
;
name
?:
string
;
description
?:
string
;
config
?:
any
;
concurrency
?:
number
;
onError
?:
"continue"
|
"stop"
;
ui
?:
any
;
inputSchema
?:
any
;
outputSchema
?:
any
;
outputExample
?:
any
;
links
?:
{
key
?:
(...)
|
(...)
;
filter
?:
any
;
name
?:
(...)
|
(...)
}
[]
;
isCustomized
?:
boolean
;
}
,
>
;
autoCreateInstances
?:
boolean
;
universalFlowRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isCustomized
?:
boolean
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
open
Configuration
openConfiguration
(
__namedParameters
?:
OpenFlowInstanceConfigurationOptions
,
)
:
Promise
<
void
>
Parameters
__namedParameters
:
OpenFlowInstanceConfigurationOptions
= {}
Returns
Promise
<
void
>
open
Editor
openEditor
(
__namedParameters
?:
OpenFlowInstanceEditorOptions
)
:
Promise
<
void
>
Parameters
__namedParameters
:
OpenFlowInstanceEditorOptions
= {}
Returns
Promise
<
void
>
embed
Editor
embedEditor
(
__namedParameters
?:
{
mountTargetSelector
?:
string
}
&
OpenFlowInstanceEditorOptions
,
)
:
Promise
<
void
>
Parameters
__namedParameters
:
{
mountTargetSelector
?:
string
}
&
OpenFlowInstanceEditorOptions
= {}
Returns
Promise
<
void
>
start
Run
startRun
(
options
?:
RunFlowOptions
,
)
:
Promise
<
{
flowInstance
?:
{
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
id
:
string
;
name
?:
string
;
flowInstanceId
:
string
;
universalFlowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
startNodeKey
:
string
;
userId
:
string
;
input
?:
any
;
state
:
FlowRunState
;
startTime
:
string
;
endTime
?:
string
;
errors
?:
ErrorDataSchema
[]
;
nodes
?:
Record
<
string
,
{
state
:
FlowRunNodeState
;
runs
?:
number
;
erroredRuns
?:
number
;
outputs
?:
number
;
}
,
>
;
launchedBy
?:
{
type
:
FlowRunLaunchedByTrigger
;
ids
?:
string
[]
}
;
}
,
>
Parameters
options
:
RunFlowOptions
= {}
Returns
Promise
<
{
flowInstance
?:
{
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
id
:
string
;
name
?:
string
;
flowInstanceId
:
string
;
universalFlowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
startNodeKey
:
string
;
userId
:
string
;
input
?:
any
;
state
:
FlowRunState
;
startTime
:
string
;
endTime
?:
string
;
errors
?:
ErrorDataSchema
[]
;
nodes
?:
Record
<
string
,
{
state
:
FlowRunNodeState
;
runs
?:
number
;
erroredRuns
?:
number
;
outputs
?:
number
;
}
,
>
;
launchedBy
?:
{
type
:
FlowRunLaunchedByTrigger
;
ids
?:
string
[]
}
;
}
,
>
run
run
(
options
?:
RunFlowOptions
,
)
:
Promise
<
{
flowInstance
?:
{
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
id
:
string
;
name
?:
string
;
flowInstanceId
:
string
;
universalFlowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
startNodeKey
:
string
;
userId
:
string
;
input
?:
any
;
state
:
FlowRunState
;
startTime
:
string
;
endTime
?:
string
;
errors
?:
ErrorDataSchema
[]
;
nodes
?:
Record
<
string
,
{
state
:
FlowRunNodeState
;
runs
?:
number
;
erroredRuns
?:
number
;
outputs
?:
number
;
}
,
>
;
launchedBy
?:
{
type
:
FlowRunLaunchedByTrigger
;
ids
?:
string
[]
}
;
}
,
>
Parameters
options
:
RunFlowOptions
= {}
Returns
Promise
<
{
flowInstance
?:
{
userId
:
string
;
connectionId
?:
string
;
flowId
?:
string
;
universalFlowId
?:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
parameters
?:
any
;
parametersSchema
?:
DataSchema
;
nodes
?:
Record
<
string
,
any
>
;
enabled
:
boolean
;
createdAt
:
string
;
updatedAt
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
customized
?:
{
name
?:
boolean
;
nodes
?:
boolean
}
;
dependencies
?:
any
[]
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
id
:
string
;
name
?:
string
;
flowInstanceId
:
string
;
universalFlowId
?:
string
;
connectionId
?:
string
;
integrationId
?:
string
;
startNodeKey
:
string
;
userId
:
string
;
input
?:
any
;
state
:
FlowRunState
;
startTime
:
string
;
endTime
?:
string
;
errors
?:
ErrorDataSchema
[]
;
nodes
?:
Record
<
string
,
{
state
:
FlowRunNodeState
;
runs
?:
number
;
erroredRuns
?:
number
;
outputs
?:
number
;
}
,
>
;
launchedBy
?:
{
type
:
FlowRunLaunchedByTrigger
;
ids
?:
string
[]
}
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
options
client
selector
Methods
get
Unique
Identifier
get
get
Id
create
put
patch
archive
delete
restore
get
Path
enable
disable
update
To
Latest
Flow
setup
reset
open
Configuration
open
Editor
embed
Editor
start
Run
run
Console
React Lib
REST API
Membrane SDK - v0.8.0
Loading...
Deprecated
archive
instead