Class ConnectionSpec

Hierarchy (View Summary)

ConnectorSpec
- ConnectionSpec

Index

Constructors

Properties

key? name? logoUri? api? ui? inputSchema? auth? parametersSchema? udms? udm? operations? test? hasReadme? externalAppId? appUuid? knowledgeBaseUuid? workspaceId? data?

Constructors

constructor

new ConnectionSpec(opts: ConnectionSpec): ConnectionSpec
Parameters
- opts: ConnectionSpec
Returns ConnectionSpec
Inherited from ConnectorSpec.constructor
- Defined in workspace-elements/base/connections/index.ts:197

Properties

`Optional`key

key?: string = ...

`Optional`name

name?: string = ...

`Optional`logoUri

logoUri?: string = ...

`Optional`api

api?: { type: "openapi" | "graphql" } = ...

`Optional`ui

ui?: {
    schema?: DataSchema;
    description?: string;
    helpUri?: string;
    test?: boolean;
} = ...

Type Declaration

Optionalschema?: DataSchema
Optionaldescription?: string
OptionalhelpUri?: string
Optionaltest?: boolean
Deprecated

Deprecated

Use inputSchema instead. Will be removed in future versions.

`Optional`inputSchema

inputSchema?: DataSchema = ...

`Optional`auth

auth?:
    | (
        ({ type: "oauth2"; title?: string | undefined; description?: string | undefined; inputSchema?: DataSchema | undefined; ui?: { schema?: DataSchema | undefined; helpUri?: string | undefined; } | undefined; ... 12 more ...; oAuthConfig?: { ...; } | ... 6 more ... | undefined; } | ... 4 more ... | { ...; }) & { ...; }
    )
    | {
        title?: string;
        description?: string;
        inputSchema?: DataSchema;
        ui?: { schema?: DataSchema; helpUri?: string };
        parametersSchema?: DataSchema;
        credentialsSchema?: DataSchema;
        customCredentialsSchema?: DataSchema;
        makeApiClient?: {
            implementationType?:
                | mapping
                | operationMapping
                | restApiMapping
                | graphqlApiMapping
                | javascript
                | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        };
        refreshCredentials?: {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        };
        test?: {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        };
        disconnect?: {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        };
        enabled?: any;
        type?: | "proxy"
        | "integration-app-token"
        | "membrane-token"
        | "oauth2"
        | "oauth1"
        | "client-credentials";
        getOAuthConfig?: | {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: mapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: operationMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: restApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: graphqlApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: javascript;
            code: string;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: notSupported;
        };
        getTokenData?: | {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: mapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: operationMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: restApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: graphqlApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: javascript;
            code: string;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: notSupported;
        };
        getCredentialsFromAccessTokenResponse?: | {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: mapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: operationMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: restApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: graphqlApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: javascript;
            code: string;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: notSupported;
        };
        getCredentialsFromRefreshTokenResponse?: | {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: mapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: operationMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: restApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: graphqlApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: javascript;
            code: string;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: notSupported;
        };
        getCredentialsFromConnectionParameters?: {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        };
        proxyKey?: string;
        oAuthConfig?: | {
            implementationType?: | mapping
            | operationMapping
            | restApiMapping
            | graphqlApiMapping
            | javascript
            | notSupported;
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: mapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: operationMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: restApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: graphqlApiMapping;
            mapping: any;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: javascript;
            code: string;
        }
        | {
            filePath?: string;
            inheritedFromPath?: string[];
            isIncomplete?: boolean;
            parametersSchema?: DataSchema;
            implementationType: notSupported;
        };
    } & {
        options: Record<
            string,
            | {
                title?: string;
                description?: string;
                inputSchema?: DataSchema;
                ui?: { schema?: DataSchema; helpUri?: string };
                parametersSchema?: DataSchema;
                credentialsSchema?: DataSchema;
                customCredentialsSchema?: DataSchema;
                makeApiClient?: {
                    implementationType?:
                        | mapping
                        | operationMapping
                        | restApiMapping
                        | graphqlApiMapping
                        | javascript
                        | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                refreshCredentials?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                test?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                disconnect?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                enabled?: any;
                type: "oauth2";
                getOAuthConfig?: | {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: mapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: operationMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: restApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: graphqlApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: javascript;
                    code: string;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: notSupported;
                };
                getTokenData?: | {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: mapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: operationMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: restApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: graphqlApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: javascript;
                    code: string;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: notSupported;
                };
                getCredentialsFromAccessTokenResponse?: | {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: mapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: operationMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: restApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: graphqlApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: javascript;
                    code: string;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: notSupported;
                };
                getCredentialsFromRefreshTokenResponse?: | {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: mapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: operationMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: restApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: graphqlApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: javascript;
                    code: string;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: notSupported;
                };
                oAuthConfig?: | {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: mapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: operationMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: restApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: graphqlApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: javascript;
                    code: string;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: notSupported;
                };
            }
            | {
                title?: string;
                description?: string;
                inputSchema?: DataSchema;
                ui?: { schema?: DataSchema; helpUri?: string };
                parametersSchema?: DataSchema;
                credentialsSchema?: DataSchema;
                customCredentialsSchema?: DataSchema;
                makeApiClient?: {
                    implementationType?:
                        | mapping
                        | operationMapping
                        | restApiMapping
                        | graphqlApiMapping
                        | javascript
                        | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                refreshCredentials?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                test?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                disconnect?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                enabled?: any;
                type: "oauth1";
                getOAuthConfig?: | {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: mapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: operationMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: restApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: graphqlApiMapping;
                    mapping: any;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: javascript;
                    code: string;
                }
                | {
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                    implementationType: notSupported;
                };
            }
            | {
                title?: string;
                description?: string;
                inputSchema?: DataSchema;
                ui?: { schema?: DataSchema; helpUri?: string };
                parametersSchema?: DataSchema;
                credentialsSchema?: DataSchema;
                customCredentialsSchema?: DataSchema;
                makeApiClient?: {
                    implementationType?:
                        | mapping
                        | operationMapping
                        | restApiMapping
                        | graphqlApiMapping
                        | javascript
                        | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                refreshCredentials?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                test?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                disconnect?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                enabled?: any;
                type: "client-credentials";
                getCredentialsFromConnectionParameters?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
            }
            | {
                title?: string;
                description?: string;
                inputSchema?: DataSchema;
                ui?: { schema?: DataSchema; helpUri?: string };
                parametersSchema?: DataSchema;
                credentialsSchema?: DataSchema;
                customCredentialsSchema?: DataSchema;
                makeApiClient?: {
                    implementationType?:
                        | mapping
                        | operationMapping
                        | restApiMapping
                        | graphqlApiMapping
                        | javascript
                        | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                refreshCredentials?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                test?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                disconnect?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                enabled?: any;
                type: "integration-app-token";
            }
            | {
                title?: string;
                description?: string;
                inputSchema?: DataSchema;
                ui?: { schema?: DataSchema; helpUri?: string };
                parametersSchema?: DataSchema;
                credentialsSchema?: DataSchema;
                customCredentialsSchema?: DataSchema;
                makeApiClient?: {
                    implementationType?:
                        | mapping
                        | operationMapping
                        | restApiMapping
                        | graphqlApiMapping
                        | javascript
                        | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                refreshCredentials?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                test?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                disconnect?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                enabled?: any;
                type: "membrane-token";
            }
            | {
                title?: string;
                description?: string;
                inputSchema?: DataSchema;
                ui?: { schema?: DataSchema; helpUri?: string };
                parametersSchema?: DataSchema;
                credentialsSchema?: DataSchema;
                customCredentialsSchema?: DataSchema;
                makeApiClient?: {
                    implementationType?:
                        | mapping
                        | operationMapping
                        | restApiMapping
                        | graphqlApiMapping
                        | javascript
                        | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                refreshCredentials?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                test?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                disconnect?: {
                    implementationType?: | mapping
                    | operationMapping
                    | restApiMapping
                    | graphqlApiMapping
                    | javascript
                    | notSupported;
                    filePath?: string;
                    inheritedFromPath?: string[];
                    isIncomplete?: boolean;
                    parametersSchema?: DataSchema;
                };
                enabled?: any;
                type: "proxy";
                proxyKey: string;
            },
        >;
    } = ...

`Optional`parametersSchema

parametersSchema?: DataSchema = ...

`Optional`udms

udms?: string[] = ...

`Optional`udm

udm?: Record<string, any> = ...

`Optional`operations

operations?: any[] = ...

`Optional`test

test?:
    | {
        implementationType?: | mapping
        | operationMapping
        | restApiMapping
        | graphqlApiMapping
        | javascript
        | notSupported;
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
    }
    | {
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
        implementationType: mapping;
        mapping: any;
    }
    | {
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
        implementationType: operationMapping;
        mapping: any;
    }
    | {
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
        implementationType: restApiMapping;
        mapping: any;
    }
    | {
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
        implementationType: graphqlApiMapping;
        mapping: any;
    }
    | {
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
        implementationType: javascript;
        code: string;
    }
    | {
        filePath?: string;
        inheritedFromPath?: string[];
        isIncomplete?: boolean;
        parametersSchema?: DataSchema;
        implementationType: notSupported;
    } = ...

`Optional`hasReadme

hasReadme?: boolean = ...

`Optional`externalAppId

externalAppId?: string = ...

`Optional`appUuid

appUuid?: string = ...

`Optional`knowledgeBaseUuid

knowledgeBaseUuid?: string = ...

`Optional`workspaceId

workspaceId?: string = ...

`Optional`data

data?: any = ...

Class ConnectionSpec

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns ConnectionSpec

Properties

`Optional`key

`Optional`name

`Optional`logoUri

`Optional`api

`Optional`ui

Type Declaration

`Optional`schema?: DataSchema

`Optional`description?: string

`Optional`helpUri?: string

`Optional`test?: boolean

Deprecated

Deprecated

`Optional`inputSchema

`Optional`auth

`Optional`parametersSchema

`Optional`udms

`Optional`udm

`Optional`operations

`Optional`test

`Optional`hasReadme

`Optional`externalAppId

`Optional`appUuid

`Optional`knowledgeBaseUuid

`Optional`workspaceId

`Optional`data

Settings

On This Page

Class ConnectionSpec

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns ConnectionSpec

Properties

Optionalkey

Optionalname

OptionallogoUri

Optionalapi

Optionalui

Type Declaration

Optionalschema?: DataSchema

Optionaldescription?: string

OptionalhelpUri?: string

Optionaltest?: boolean

Deprecated

Deprecated

OptionalinputSchema

Optionalauth

OptionalparametersSchema

Optionaludms

Optionaludm

Optionaloperations

Optionaltest

OptionalhasReadme

OptionalexternalAppId

OptionalappUuid

OptionalknowledgeBaseUuid

OptionalworkspaceId

Optionaldata

Settings

On This Page

`Optional`key

`Optional`name

`Optional`logoUri

`Optional`api

`Optional`ui

`Optional`schema?: DataSchema

`Optional`description?: string

`Optional`helpUri?: string

`Optional`test?: boolean

`Optional`inputSchema

`Optional`auth

`Optional`parametersSchema

`Optional`udms

`Optional`udm

`Optional`operations

`Optional`test

`Optional`hasReadme

`Optional`externalAppId

`Optional`appUuid

`Optional`knowledgeBaseUuid

`Optional`workspaceId

`Optional`data