Membrane SDK - v0.8.0
Console
React Lib
REST API
Preparing search index...
FieldMappingInstanceAccessor
Class FieldMappingInstanceAccessor
Hierarchy (
View Summary
)
ElementInstanceAccessor
<
FieldMappingInstance
,
FieldMappingInstanceSelector
,
CreateFieldMappingInstanceRequest
,
UpdateFieldMappingInstanceRequest
,
>
FieldMappingInstanceAccessor
Index
Constructors
constructor
Properties
options
Methods
get
Unique
Identifier
get
get
Id
create
put
patch
archive
delete
restore
get
Path
setup
reset
open
Configuration
Constructors
constructor
new
FieldMappingInstanceAccessor
(
client
:
MembraneApiClient
,
selector
:
string
|
FieldMappingInstanceSelector
,
)
:
FieldMappingInstanceAccessor
Parameters
client
:
MembraneApiClient
selector
:
string
|
FieldMappingInstanceSelector
Returns
FieldMappingInstanceAccessor
Properties
Protected
options
options
:
{
client
:
MembraneApiClient
;
instancePath
:
string
;
selector
:
string
|
FieldMappingInstanceSelector
;
type
?:
WorkspaceElementType
;
}
Methods
get
Unique
Identifier
getUniqueIdentifier
()
:
string
Returns
string
get
get
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
get
Id
getId
()
:
Promise
<
string
>
Returns
Promise
<
string
>
create
create
(
data
?:
CreateFieldMappingInstanceRequest
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
Optional
data
:
CreateFieldMappingInstanceRequest
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
put
put
(
data
:
CreateFieldMappingInstanceRequest
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
data
:
CreateFieldMappingInstanceRequest
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
patch
patch
(
data
:
UpdateFieldMappingInstanceRequest
,
)
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
data
:
UpdateFieldMappingInstanceRequest
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
archive
archive
()
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
delete
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Deprecated
use
archive
instead
restore
restore
()
:
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Returns
Promise
<
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
fieldMapping
?:
{
universalFieldMappingId
?:
string
;
dataSourceKey
?:
string
;
dataSourceId
?:
string
;
appSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
defaultImportValue
?:
any
;
defaultExportValue
?:
any
;
importValue
?:
any
;
exportValue
?:
any
;
frozenImportFields
?:
any
;
frozenExportFields
?:
any
;
frozenUnifiedExportFields
?:
any
;
universalFieldMappingRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
dataSourceInstance
?:
{
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
dataSource
?:
{
universalDataSourceId
?:
string
;
udm
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultPath
?:
string
;
universalDataSourceRevision
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
integrationId
?:
string
;
isCustomized
?:
boolean
;
}
;
connection
?:
{
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
id
:
string
;
}
;
integration
?:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
userId
:
string
;
revision
:
string
;
dataSourceRevision
?:
string
;
dataSourceId
?:
string
;
universalDataSourceId
?:
string
;
udm
?:
string
;
connectionId
:
string
;
integrationId
:
string
;
instanceKey
?:
string
;
collectionKey
?:
string
;
collectionParameters
?:
any
;
defaultCollectionKey
?:
string
;
defaultCollectionParameters
?:
any
;
collectionSpec
?:
{
type
:
"collection"
;
key
?:
string
;
name
:
string
;
parametersSchema
?:
DataSchema
;
fieldsSchema
?:
DataSchema
;
list
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
filterFields
?:
string
[]
;
}
;
search
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
match
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
}
;
findById
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
create
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
requiredFields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
update
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
fields
?:
string
[]
;
excludedFields
?:
string
[]
;
}
;
delete
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
}
;
events
?:
{
created
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
updated
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
deleted
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
all
?:
{
type
:
(...)
|
(...)
;
isFullScan
?:
(...)
|
(...)
|
(...)
;
isIdOnly
?:
(...)
|
(...)
|
(...)
;
}
;
[
key
:
string
]:
{
type
:
"push"
|
"pull"
;
isFullScan
?:
boolean
;
isIdOnly
?:
boolean
;
}
;
}
;
customFields
?:
boolean
;
udm
?:
Record
<
string
,
{
fields
?:
(...)
[]
;
extract
?:
Record
<
(...)
,
(...)
>
;
parse
?:
Record
<
(...)
,
(...)
>
;
}
,
>
;
find
?:
{
apiRequests
?:
{
path
:
...
;
method
:
...
}
[]
;
queryFields
?:
string
[]
;
}
;
}
;
isCustomized
?:
boolean
;
errors
?:
ErrorDataSchema
[]
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
path
?:
string
;
defaultPath
?:
string
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
userId
:
string
;
revision
:
string
;
connectionId
:
string
;
integrationId
:
string
;
fieldMappingRevision
?:
string
;
fieldMappingId
?:
string
;
instanceKey
?:
string
;
dataSourceInstanceId
?:
string
;
dataSourceSchema
?:
DataSchema
;
direction
?:
IMPORT
|
EXPORT
|
BOTH
;
appSchema
?:
DataSchema
;
importValue
?:
any
;
exportValue
?:
any
;
isCustomized
?:
boolean
;
unifiedExportValue
?:
any
;
unifiedImportValue
?:
any
;
frozenImportFields
?:
string
[]
;
frozenExportFields
?:
string
[]
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
externalSchema
?:
any
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Protected
get
Path
getPath
(
operation
?:
string
)
:
string
Parameters
operation
:
string
= ''
Returns
string
setup
setup
()
:
Promise
<
void
>
Returns
Promise
<
void
>
reset
reset
()
:
Promise
<
void
>
Returns
Promise
<
void
>
open
Configuration
openConfiguration
(
__namedParameters
?:
OpenFieldMappingInstanceConfigurationOptions
,
)
:
Promise
<
void
>
Parameters
__namedParameters
:
OpenFieldMappingInstanceConfigurationOptions
= {}
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
options
Methods
get
Unique
Identifier
get
get
Id
create
put
patch
archive
delete
restore
get
Path
setup
reset
open
Configuration
Console
React Lib
REST API
Membrane SDK - v0.8.0
Loading...
Deprecated
archive
instead