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

    Variable ConnectorSpecConst

    ConnectorSpec: ZodObject<
        {
            key: ZodOptional<ZodString>;
            name: ZodOptional<ZodString>;
            logoUri: ZodOptional<ZodString>;
            api: ZodOptional<
                ZodObject<
                    { type: ZodEnum<{ openapi: "openapi"; graphql: "graphql" }> },
                    $strip,
                >,
            >;
            ui: ZodOptional<
                ZodObject<
                    {
                        schema: ZodOptional<
                            ZodType<
                                DataSchema,
                                unknown,
                                $ZodTypeInternals<DataSchema, unknown>,
                            >,
                        >;
                        description: ZodOptional<ZodString>;
                        helpUri: ZodOptional<ZodString>;
                        test: ZodOptional<ZodBoolean>;
                    },
                    $strip,
                >,
            >;
            inputSchema: ZodOptional<
                ZodType<DataSchema, unknown, $ZodTypeInternals<DataSchema, unknown>>,
            >;
            auth: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodIntersection<
                            ZodUnion<
                                readonly [
                                    ZodObject<
                                        {
                                            title: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            inputSchema: ZodOptional<(...)>;
                                            ui: ZodOptional<(...)>;
                                            parametersSchema: ZodOptional<(...)>;
                                            credentialsSchema: ZodOptional<(...)>;
                                            customCredentialsSchema: ZodOptional<(...)>;
                                            makeApiClient: ZodOptional<(...)>;
                                            refreshCredentials: ZodOptional<(...)>;
                                            test: ZodOptional<(...)>;
                                            disconnect: ZodOptional<(...)>;
                                            enabled: ZodOptional<(...)>;
                                            type: ZodLiteral<(...)>;
                                            getOAuthConfig: ZodOptional<(...)>;
                                            getTokenData: ZodOptional<(...)>;
                                            getCredentialsFromAccessTokenResponse: ZodOptional<(...)>;
                                            getCredentialsFromRefreshTokenResponse: ZodOptional<(...)>;
                                            oAuthConfig: ZodOptional<(...)>;
                                        },
                                        $strip,
                                    >,
                                    ZodObject<
                                        {
                                            title: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            inputSchema: ZodOptional<(...)>;
                                            ui: ZodOptional<(...)>;
                                            parametersSchema: ZodOptional<(...)>;
                                            credentialsSchema: ZodOptional<(...)>;
                                            customCredentialsSchema: ZodOptional<(...)>;
                                            makeApiClient: ZodOptional<(...)>;
                                            refreshCredentials: ZodOptional<(...)>;
                                            test: ZodOptional<(...)>;
                                            disconnect: ZodOptional<(...)>;
                                            enabled: ZodOptional<(...)>;
                                            type: ZodLiteral<(...)>;
                                            getOAuthConfig: ZodOptional<(...)>;
                                        },
                                        $strip,
                                    >,
                                    ZodObject<
                                        {
                                            title: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            inputSchema: ZodOptional<(...)>;
                                            ui: ZodOptional<(...)>;
                                            parametersSchema: ZodOptional<(...)>;
                                            credentialsSchema: ZodOptional<(...)>;
                                            customCredentialsSchema: ZodOptional<(...)>;
                                            makeApiClient: ZodOptional<(...)>;
                                            refreshCredentials: ZodOptional<(...)>;
                                            test: ZodOptional<(...)>;
                                            disconnect: ZodOptional<(...)>;
                                            enabled: ZodOptional<(...)>;
                                            type: ZodLiteral<(...)>;
                                            getCredentialsFromConnectionParameters: ZodOptional<(...)>;
                                        },
                                        $strip,
                                    >,
                                    ZodObject<
                                        {
                                            title: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            inputSchema: ZodOptional<(...)>;
                                            ui: ZodOptional<(...)>;
                                            parametersSchema: ZodOptional<(...)>;
                                            credentialsSchema: ZodOptional<(...)>;
                                            customCredentialsSchema: ZodOptional<(...)>;
                                            makeApiClient: ZodOptional<(...)>;
                                            refreshCredentials: ZodOptional<(...)>;
                                            test: ZodOptional<(...)>;
                                            disconnect: ZodOptional<(...)>;
                                            enabled: ZodOptional<(...)>;
                                            type: ZodLiteral<(...)>;
                                        },
                                        $strip,
                                    >,
                                    ZodObject<
                                        {
                                            title: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            inputSchema: ZodOptional<(...)>;
                                            ui: ZodOptional<(...)>;
                                            parametersSchema: ZodOptional<(...)>;
                                            credentialsSchema: ZodOptional<(...)>;
                                            customCredentialsSchema: ZodOptional<(...)>;
                                            makeApiClient: ZodOptional<(...)>;
                                            refreshCredentials: ZodOptional<(...)>;
                                            test: ZodOptional<(...)>;
                                            disconnect: ZodOptional<(...)>;
                                            enabled: ZodOptional<(...)>;
                                            type: ZodLiteral<(...)>;
                                        },
                                        $strip,
                                    >,
                                    ZodObject<
                                        {
                                            title: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            inputSchema: ZodOptional<(...)>;
                                            ui: ZodOptional<(...)>;
                                            parametersSchema: ZodOptional<(...)>;
                                            credentialsSchema: ZodOptional<(...)>;
                                            customCredentialsSchema: ZodOptional<(...)>;
                                            makeApiClient: ZodOptional<(...)>;
                                            refreshCredentials: ZodOptional<(...)>;
                                            test: ZodOptional<(...)>;
                                            disconnect: ZodOptional<(...)>;
                                            enabled: ZodOptional<(...)>;
                                            type: ZodLiteral<(...)>;
                                            proxyKey: ZodString;
                                        },
                                        $strip,
                                    >,
                                ],
                            >,
                            ZodObject<
                                { options: ZodOptional<ZodRecord<ZodString, ZodUnion<(...)>>> },
                                $strip,
                            >,
                        >,
                        ZodIntersection<
                            ZodObject<
                                {
                                    title: ZodOptional<ZodString>;
                                    description: ZodOptional<ZodString>;
                                    inputSchema: ZodOptional<
                                        ZodType<DataSchema, unknown, $ZodTypeInternals<(...), (...)>>,
                                    >;
                                    ui: ZodOptional<ZodObject<{ schema: ...; helpUri: ... }, $strip>>;
                                    parametersSchema: ZodOptional<
                                        ZodType<DataSchema, unknown, $ZodTypeInternals<(...), (...)>>,
                                    >;
                                    credentialsSchema: ZodOptional<
                                        ZodType<DataSchema, unknown, $ZodTypeInternals<(...), (...)>>,
                                    >;
                                    customCredentialsSchema: ZodOptional<
                                        ZodType<DataSchema, unknown, $ZodTypeInternals<(...), (...)>>,
                                    >;
                                    makeApiClient: ZodOptional<
                                        ZodObject<
                                            {
                                                implementationType: ...;
                                                filePath: ...;
                                                inheritedFromPath: ...;
                                                isIncomplete: ...;
                                                parametersSchema: ...;
                                            },
                                            $strip,
                                        >,
                                    >;
                                    refreshCredentials: ZodOptional<
                                        ZodObject<
                                            {
                                                implementationType: ...;
                                                filePath: ...;
                                                inheritedFromPath: ...;
                                                isIncomplete: ...;
                                                parametersSchema: ...;
                                            },
                                            $strip,
                                        >,
                                    >;
                                    test: ZodOptional<
                                        ZodObject<
                                            {
                                                implementationType: ...;
                                                filePath: ...;
                                                inheritedFromPath: ...;
                                                isIncomplete: ...;
                                                parametersSchema: ...;
                                            },
                                            $strip,
                                        >,
                                    >;
                                    disconnect: ZodOptional<
                                        ZodObject<
                                            {
                                                implementationType: ...;
                                                filePath: ...;
                                                inheritedFromPath: ...;
                                                isIncomplete: ...;
                                                parametersSchema: ...;
                                            },
                                            $strip,
                                        >,
                                    >;
                                    enabled: ZodOptional<ZodAny>;
                                    type: ZodOptional<
                                        ZodEnum<
                                            {
                                                proxy: ...;
                                                "integration-app-token": ...;
                                                "membrane-token": ...;
                                                oauth2: ...;
                                                oauth1: ...;
                                                "client-credentials": ...;
                                            },
                                        >,
                                    >;
                                    getOAuthConfig: ZodOptional<
                                        ZodUnion<
                                            readonly [(...), (...), (...), (...), (...), (...), (...)],
                                        >,
                                    >;
                                    getTokenData: ZodOptional<
                                        ZodUnion<
                                            readonly [(...), (...), (...), (...), (...), (...), (...)],
                                        >,
                                    >;
                                    getCredentialsFromAccessTokenResponse: ZodOptional<
                                        ZodUnion<
                                            readonly [(...), (...), (...), (...), (...), (...), (...)],
                                        >,
                                    >;
                                    getCredentialsFromRefreshTokenResponse: ZodOptional<
                                        ZodUnion<
                                            readonly [(...), (...), (...), (...), (...), (...), (...)],
                                        >,
                                    >;
                                    getCredentialsFromConnectionParameters: ZodOptional<
                                        ZodObject<
                                            {
                                                implementationType: ...;
                                                filePath: ...;
                                                inheritedFromPath: ...;
                                                isIncomplete: ...;
                                                parametersSchema: ...;
                                            },
                                            $strip,
                                        >,
                                    >;
                                    proxyKey: ZodOptional<ZodString>;
                                    oAuthConfig: ZodOptional<
                                        ZodUnion<
                                            readonly [(...), (...), (...), (...), (...), (...), (...)],
                                        >,
                                    >;
                                },
                                $strip,
                            >,
                            ZodObject<
                                {
                                    options: ZodRecord<
                                        ZodString,
                                        ZodUnion<readonly [(...), (...), (...), (...), (...), (...)]>,
                                    >;
                                },
                                $strip,
                            >,
                        >,
                    ],
                >,
            >;
            parametersSchema: ZodOptional<
                ZodType<DataSchema, unknown, $ZodTypeInternals<DataSchema, unknown>>,
            >;
            udms: ZodOptional<ZodArray<ZodString>>;
            udm: ZodOptional<ZodRecord<ZodString, ZodAny>>;
            operations: ZodOptional<ZodArray<ZodAny>>;
            test: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodObject<
                            {
                                implementationType: ZodOptional<
                                    ZodEnum<typeof ConnectorMethodImplementationType>,
                                >;
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                            },
                            $strip,
                        >,
                        ZodObject<
                            {
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                                implementationType: ZodLiteral<mapping>;
                                mapping: ZodAny;
                            },
                            $strip,
                        >,
                        ZodObject<
                            {
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                                implementationType: ZodLiteral<operationMapping>;
                                mapping: ZodAny;
                            },
                            $strip,
                        >,
                        ZodObject<
                            {
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                                implementationType: ZodLiteral<restApiMapping>;
                                mapping: ZodAny;
                            },
                            $strip,
                        >,
                        ZodObject<
                            {
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                                implementationType: ZodLiteral<graphqlApiMapping>;
                                mapping: ZodAny;
                            },
                            $strip,
                        >,
                        ZodObject<
                            {
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                                implementationType: ZodLiteral<javascript>;
                                code: ZodString;
                            },
                            $strip,
                        >,
                        ZodObject<
                            {
                                filePath: ZodOptional<ZodString>;
                                inheritedFromPath: ZodOptional<ZodArray<ZodString>>;
                                isIncomplete: ZodOptional<ZodBoolean>;
                                parametersSchema: ZodOptional<
                                    ZodType<
                                        DataSchema,
                                        unknown,
                                        $ZodTypeInternals<DataSchema, unknown>,
                                    >,
                                >;
                                implementationType: ZodLiteral<notSupported>;
                            },
                            $strip,
                        >,
                    ],
                >,
            >;
            hasReadme: ZodOptional<ZodBoolean>;
            externalAppId: ZodOptional<ZodString>;
            appUuid: ZodOptional<ZodString>;
            knowledgeBaseUuid: ZodOptional<ZodString>;
            workspaceId: ZodOptional<ZodString>;
            data: ZodOptional<ZodAny>;
        },
        $strip,
    > = ...