Function getEffectiveConnectorOption

Parameters

• connector: {
      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;
      baseUri?: string;
      revision?: string;
      dataCollectionsCount?: number;
      operationsCount?: number;
      eventsCount?: number;
      udms?: string[];
      hasTest?: boolean;
      hasAuthTest?: boolean;
      hasOperations?: boolean;
      hasData?: boolean;
      isReadOnly?: boolean;
      version: string;
      credentialsSchema?: 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;
              credentialsSchema?: DataSchema;
          },
      >;
  }

  • 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 }

    Deprecated

    Use inputSchema instead. Will be removed in future versions.

  • OptionalparametersSchema?: DataSchema

  • OptionalbaseUri?: string

    Storage URI of the connector's files. undefined for fileless connectors served from the remote repository.

  • Optionalrevision?: string

  • OptionaldataCollectionsCount?: number

  • OptionaloperationsCount?: number

  • OptionaleventsCount?: number

  • Optionaludms?: string[]

  • OptionalhasTest?: boolean

  • OptionalhasAuthTest?: boolean

  • OptionalhasOperations?: boolean

  • OptionalhasData?: boolean

  • OptionalisReadOnly?: boolean

  • version: string

  • OptionalcredentialsSchema?: 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;
            credentialsSchema?: DataSchema;
        },
    >

• optionKey: string