Membrane React - v0.6.0
Console
SDK
REST API
Preparing search index...
PackageAccessor
Class PackageAccessor
Hierarchy (
View Summary
)
ElementAccessor
<
PackageApiResponse
,
Partial
<
PackageEditableProperties
>
>
PackageAccessor
Index
Constructors
constructor
Methods
get
Unique
Identifier
get
put
patch
archive
restore
get
Path
Properties
options
Constructors
constructor
new
PackageAccessor
(
client
:
MembraneApiClient
,
selector
:
string
,
)
:
PackageAccessor
Parameters
client
:
MembraneApiClient
selector
:
string
Returns
PackageAccessor
Methods
get
Unique
Identifier
getUniqueIdentifier
()
:
string
Returns
string
get
get
()
:
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
Returns
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
put
put
(
data
:
UpdateRequest
,
)
:
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
Parameters
data
:
UpdateRequest
Returns
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
patch
patch
(
data
:
Partial
<
UpdateRequest
>
,
)
:
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
Parameters
data
:
Partial
<
UpdateRequest
>
Returns
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
archive
archive
()
:
Promise
<
void
>
Returns
Promise
<
void
>
restore
restore
()
:
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
Returns
Promise
<
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
appliedToIntegrations
?:
{
element
:
{
id
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
}
;
integration
:
{
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
;
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"
;
}
;
}
[]
;
}
,
>
get
Path
getPath
(
operation
?:
string
)
:
string
Parameters
Optional
operation
:
string
Returns
string
Properties
Protected
options
options
:
{
client
:
MembraneApiClient
;
path
:
string
;
selector
:
string
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
Unique
Identifier
get
put
patch
archive
restore
get
Path
Properties
options
Console
SDK
REST API
Membrane React - v0.6.0
Loading...