Membrane SDK - v0.29.2
Console
React Lib
REST API
Preparing search index...
ConnectionLevelFieldMappingAccessor
Class ConnectionLevelFieldMappingAccessor
Hierarchy (
View Summary
)
ConnectionLevelElementAccessor
<
FieldMappingApiResponse
,
UpdateFieldMappingRequest
,
>
ConnectionLevelFieldMappingAccessor
Index
Constructors
constructor
Properties
client
connection
Selector
field
Mapping
Selector
query
endpoint
selector
element
Key
Methods
open
Configuration
uri
get
Unique
Identifier
get
create
patch
put
archive
reset
setup
Constructors
constructor
new
ConnectionLevelFieldMappingAccessor
(
client
:
MembraneApiClient
,
connectionSelector
:
string
,
fieldMappingSelector
:
string
,
query
:
InstanceKeyQuery
,
)
:
ConnectionLevelFieldMappingAccessor
Parameters
client
:
MembraneApiClient
connectionSelector
:
string
fieldMappingSelector
:
string
query
:
InstanceKeyQuery
Returns
ConnectionLevelFieldMappingAccessor
Properties
client
client
:
MembraneApiClient
connection
Selector
connectionSelector
:
string
field
Mapping
Selector
fieldMappingSelector
:
string
query
query
:
InstanceKeyQuery
Protected
endpoint
endpoint
:
string
Protected
selector
selector
:
string
Protected
element
Key
elementKey
:
string
Methods
open
Configuration
openConfiguration
(
__namedParameters
?:
OpenFieldMappingInstanceConfigurationOptions
,
)
:
Promise
<
void
>
Parameters
__namedParameters
:
OpenFieldMappingInstanceConfigurationOptions
= {}
Returns
Promise
<
void
>
Protected
uri
uri
(
path
?:
string
,
query
?:
{}
)
:
string
Parameters
path
:
string
= ''
query
:
{}
= {}
Returns
string
get
Unique
Identifier
getUniqueIdentifier
()
:
string
Returns
string
get
get
(
query
?:
{
autoCreate
?:
boolean
}
,
)
:
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Parameters
query
:
{
autoCreate
?:
boolean
}
= {}
Returns
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
create
create
()
:
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Returns
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
patch
patch
(
data
:
Partial
<
UpdateElement
>
,
)
:
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Parameters
data
:
Partial
<
UpdateElement
>
Returns
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
put
put
(
data
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
uuid
?:
string
;
key
?:
string
;
name
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
}
,
)
:
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Parameters
data
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
uuid
?:
string
;
key
?:
string
;
name
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
}
Returns
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
archive
archive
()
:
Promise
<
void
>
Returns
Promise
<
void
>
reset
reset
()
:
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Returns
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
setup
setup
()
:
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Returns
Promise
<
{
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
string
,
any
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
appliedToIntegrations
?:
{
element
:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
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
;
externalAppId
?:
string
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
optionsConfig
?:
Record
<
string
,
{
disabled
?:
boolean
;
parameters
?:
Record
<
(...)
,
(...)
>
}
,
>
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isReadOnly
?:
boolean
;
}
;
}
[]
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
isActive
?:
boolean
;
aiCreditsRolling30DayLimit
?:
number
|
null
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
type
?:
"connector"
|
"mcp"
;
name
:
string
;
key
?:
string
;
isTest
?:
boolean
;
connected
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
requestError
?:
ErrorDataSchema
;
error
?:
ErrorDataSchema
;
integrationId
?:
string
;
connectorId
?:
string
;
externalAppId
?:
string
;
connectorVersion
?:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
nextRetryTimestamp
?:
string
;
retryAttempts
?:
number
;
canTest
?:
boolean
;
canRefreshCredentials
?:
boolean
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
buildingAgentSessionId
?:
string
;
clientAction
?:
{
type
:
"connect"
|
"provide-input"
;
description
:
string
;
uiUrl
?:
string
;
agentInstructions
?:
string
;
handoffAgentInstructions
?:
string
;
reason
?:
"provide-input"
|
"authenticate"
|
"reauthenticate"
;
}
;
id
:
string
;
userId
:
string
;
tenantId
?:
string
;
}
;
fieldMapping
?:
{
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
;
connectionId
?:
string
;
instanceKey
?:
string
;
fieldMappingId
?:
string
;
universalFieldMappingId
?:
string
;
dataSourceId
?:
string
;
dataSourceUuid
?:
string
;
dataSourceKey
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
unifiedImportValue
?:
any
;
unifiedExportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
fieldMappingRevision
?:
string
;
universalFieldMappingRevision
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
isCustomized
?:
boolean
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
integrationId
?:
string
;
integrationUuid
?:
string
;
integrationKey
?:
string
;
parentUuid
?:
string
;
parentKey
?:
string
;
isUniversal
?:
boolean
;
externalAppId
?:
string
;
externalAppUuid
?:
string
;
externalAppKey
?:
string
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
connection
Selector
field
Mapping
Selector
query
endpoint
selector
element
Key
Methods
open
Configuration
uri
get
Unique
Identifier
get
create
patch
put
archive
reset
setup
Console
React Lib
REST API
Membrane SDK - v0.29.2
Loading...