Membrane SDK - v0.29.2
Console
React Lib
REST API
Preparing search index...
ConnectorFunctionSpec
Interface ConnectorFunctionSpec
interface
ConnectorFunctionSpec
{
authTypes
?:
(
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
)
[]
;
getInputSchema
?:
(
authConfig
:
{
type
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
credentialsSchema
?:
DataSchema
;
customCredentialsSchema
?:
DataSchema
;
inputSchema
?:
DataSchema
;
parametersSchema
?:
DataSchema
;
getCredentialsFromConnectionParameters
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
refreshCredentials
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
makeApiClient
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getOAuthConfig
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getTokenData
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromAccessTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromRefreshTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
test
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
disconnect
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
proxyKey
?:
string
;
ui
?:
{
schema
?:
DataSchema
;
description
?:
string
;
helpUri
?:
string
}
;
}
,
)
=>
DataSchema
|
undefined
;
getOutputSchema
?:
(
authConfig
:
{
type
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
credentialsSchema
?:
DataSchema
;
customCredentialsSchema
?:
DataSchema
;
inputSchema
?:
DataSchema
;
parametersSchema
?:
DataSchema
;
getCredentialsFromConnectionParameters
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
refreshCredentials
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
makeApiClient
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getOAuthConfig
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getTokenData
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromAccessTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromRefreshTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
test
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
disconnect
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
proxyKey
?:
string
;
ui
?:
{
schema
?:
DataSchema
;
description
?:
string
;
helpUri
?:
string
}
;
}
,
)
=>
DataSchema
|
undefined
;
supportedFunctionTypes
:
FunctionType
[]
;
isRequired
:
boolean
;
}
Index
Properties
auth
Types?
get
Input
Schema?
get
Output
Schema?
supported
Function
Types
is
Required
Properties
Optional
auth
Types
authTypes
?:
(
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
)
[]
Optional
get
Input
Schema
getInputSchema
?:
(
authConfig
:
{
type
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
credentialsSchema
?:
DataSchema
;
customCredentialsSchema
?:
DataSchema
;
inputSchema
?:
DataSchema
;
parametersSchema
?:
DataSchema
;
getCredentialsFromConnectionParameters
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
refreshCredentials
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
makeApiClient
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getOAuthConfig
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getTokenData
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromAccessTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromRefreshTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
test
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
disconnect
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
proxyKey
?:
string
;
ui
?:
{
schema
?:
DataSchema
;
description
?:
string
;
helpUri
?:
string
}
;
}
,
)
=>
DataSchema
|
undefined
Optional
get
Output
Schema
getOutputSchema
?:
(
authConfig
:
{
type
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
credentialsSchema
?:
DataSchema
;
customCredentialsSchema
?:
DataSchema
;
inputSchema
?:
DataSchema
;
parametersSchema
?:
DataSchema
;
getCredentialsFromConnectionParameters
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
refreshCredentials
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
makeApiClient
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getOAuthConfig
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getTokenData
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromAccessTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
getCredentialsFromRefreshTokenResponse
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
test
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
disconnect
?:
{
type
?:
|
"mapping"
|
"operation-mapping"
|
"rest-api-mapping"
|
"graphql-api-mapping"
|
"javascript"
;
[
key
:
string
]:
unknown
;
}
;
proxyKey
?:
string
;
ui
?:
{
schema
?:
DataSchema
;
description
?:
string
;
helpUri
?:
string
}
;
}
,
)
=>
DataSchema
|
undefined
supported
Function
Types
supportedFunctionTypes
:
FunctionType
[]
is
Required
isRequired
:
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
auth
Types
get
Input
Schema
get
Output
Schema
supported
Function
Types
is
Required
Console
React Lib
REST API
Membrane SDK - v0.29.2
Loading...