Membrane SDK - v0.29.2
    Preparing search index...

    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

    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