Membrane SDK - v0.8.0
Console
React Lib
REST API
Preparing search index...
PackagesAccessor
Class PackagesAccessor
Hierarchy (
View Summary
)
ElementListAccessor
<
PackageApiResponse
,
FindPackagesQuery
,
PackageEditableProperties
,
>
PackagesAccessor
Index
Constructors
constructor
Methods
find
find
All
create
Constructors
constructor
new
PackagesAccessor
(
client
:
MembraneApiClient
)
:
PackagesAccessor
Parameters
client
:
MembraneApiClient
Returns
PackagesAccessor
Methods
find
find
(
query
?:
{
includeArchived
?:
boolean
;
search
?:
string
;
limit
?:
number
;
cursor
?:
string
;
integrationId
?:
string
;
integrationKey
?:
string
;
parentId
?:
string
;
}
,
)
:
Promise
<
PaginationResponse
<
{
appliedToIntegrations
?:
{
element
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
,
>
Parameters
Optional
query
:
{
includeArchived
?:
boolean
;
search
?:
string
;
limit
?:
number
;
cursor
?:
string
;
integrationId
?:
string
;
integrationKey
?:
string
;
parentId
?:
string
;
}
Returns
Promise
<
PaginationResponse
<
{
appliedToIntegrations
?:
{
element
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
,
>
find
All
findAll
(
query
?:
Omit
<
{
includeArchived
?:
boolean
;
search
?:
string
;
limit
?:
number
;
cursor
?:
string
;
integrationId
?:
string
;
integrationKey
?:
string
;
parentId
?:
string
;
}
,
"limit"
,
>
,
)
:
Promise
<
{
appliedToIntegrations
?:
{
element
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
[]
,
>
Parameters
Optional
query
:
Omit
<
{
includeArchived
?:
boolean
;
search
?:
string
;
limit
?:
number
;
cursor
?:
string
;
integrationId
?:
string
;
integrationKey
?:
string
;
parentId
?:
string
;
}
,
"limit"
,
>
Returns
Promise
<
{
appliedToIntegrations
?:
{
element
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
[]
,
>
create
create
(
data
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
?:
string
;
name
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
}
,
)
:
Promise
<
{
appliedToIntegrations
?:
{
element
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Parameters
data
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
?:
string
;
name
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
}
Returns
Promise
<
{
appliedToIntegrations
?:
{
element
:
{
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
;
integration
:
{
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
}
;
}
[]
;
scenarioTemplateId
?:
string
;
elements
?:
{
id
:
string
;
type
:
IntegrationElementType
;
element
?:
any
}
[]
;
integrationId
?:
string
;
parentId
?:
string
;
key
:
string
;
name
:
string
;
isCustomized
?:
boolean
;
id
:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
find
find
All
create
Console
React Lib
REST API
Membrane SDK - v0.8.0
Loading...