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

    Interface ConnectorExport

    interface ConnectorExport {
        key: string;
        spec: {
            type?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
            customCredentialsSchema?: DataSchema;
            inputSchema?: 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 };
            parametersSchema?: DataSchema;
            options?: Record<
                string,
                {
                    type?: | "proxy"
                    | "integration-app-token"
                    | "membrane-token"
                    | "oauth2"
                    | "oauth1"
                    | "client-credentials";
                    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 };
                    title?: string;
                    description?: string;
                    enabled?: any;
                },
            >;
            key: string;
            name?: string;
            logoUri?: string;
            externalAppUuid?: string;
            appUuid?: string;
            categories?: string[];
            uuid: string;
        };
        versions: ConnectorVersionExport[];
        isPublic: boolean;
    }
    Index

    Properties

    key: string
    spec: {
        type?:
            | "proxy"
            | "integration-app-token"
            | "membrane-token"
            | "oauth2"
            | "oauth1"
            | "client-credentials";
        customCredentialsSchema?: DataSchema;
        inputSchema?: 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 };
        parametersSchema?: DataSchema;
        options?: Record<
            string,
            {
                type?: | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
                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 };
                title?: string;
                description?: string;
                enabled?: any;
            },
        >;
        key: string;
        name?: string;
        logoUri?: string;
        externalAppUuid?: string;
        appUuid?: string;
        categories?: string[];
        uuid: string;
    }

    Type Declaration

    • Optionaltype?:
          | "proxy"
          | "integration-app-token"
          | "membrane-token"
          | "oauth2"
          | "oauth1"
          | "client-credentials"
    • OptionalcustomCredentialsSchema?: DataSchema
    • OptionalinputSchema?: DataSchema
    • OptionalgetCredentialsFromConnectionParameters?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalrefreshCredentials?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalmakeApiClient?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalgetOAuthConfig?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalgetTokenData?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalgetCredentialsFromAccessTokenResponse?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalgetCredentialsFromRefreshTokenResponse?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • Optionaltest?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • Optionaldisconnect?: {
          type?:
              | "mapping"
              | "operation-mapping"
              | "rest-api-mapping"
              | "graphql-api-mapping"
              | "javascript";
          [key: string]: unknown;
      }
    • OptionalproxyKey?: string
    • Optionalui?: { schema?: DataSchema; description?: string; helpUri?: string }

      Use inputSchema instead. Will be removed in future versions.

    • OptionalparametersSchema?: DataSchema
    • Optionaloptions?: Record<
          string,
          {
              type?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              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 };
              title?: string;
              description?: string;
              enabled?: any;
          },
      >
    • key: string
    • Optionalname?: string
    • OptionallogoUri?: string
    • OptionalexternalAppUuid?: string
    • OptionalappUuid?: string
    • Optionalcategories?: string[]
    • uuid: string
    isPublic: boolean