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

    Class IntegrationsAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • Optionalquery: {
            limit?: number;
            cursor?: string;
            includeArchived?: boolean;
            search?: string;
            appUuid?: string;
            connectors?: number;
            externalApps?: number;
            websearch?: number;
            all?: number;
        }

      Returns Promise<
          PaginationResponse<
              {
                  connection?: {
                      type?: "connector"
                      | "mcp";
                      name: string;
                      key?: string;
                      isTest?: boolean;
                      connected?: boolean;
                      disconnected?: boolean;
                      isDefunct?: boolean;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      requestError?: ErrorDataSchema;
                      error?: ErrorDataSchema;
                      integrationId?: string;
                      connectorId?: string;
                      externalAppId?: string;
                      connectorVersion?: string;
                      authOptionKey?: string;
                      createdAt: string;
                      updatedAt: string;
                      lastActiveAt?: string;
                      nextCredentialsRefreshAt?: string;
                      nextRetryTimestamp?: string;
                      retryAttempts?: number;
                      canTest?: boolean;
                      canRefreshCredentials?: boolean;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                      buildingAgentSessionId?: string;
                      clientAction?: {
                          type: "connect" | "provide-input";
                          description: string;
                          uiUrl?: string;
                          agentInstructions?: string;
                          handoffAgentInstructions?: string;
                          reason?: "provide-input" | "authenticate" | "reauthenticate";
                      };
                      id: string;
                      userId: string;
                      tenantId?: string;
                  };
                  spec?: any;
                  authOptions?: {
                      key: string;
                      type: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      title?: string;
                      description?: string;
                      inputSchema?: DataSchema;
                      ui?: { schema?: any; helpUri?: string };
                  }[];
                  id?: string;
                  logoUri?: string;
                  appUri?: string;
                  isConnected?: boolean;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  externalAppId?: string;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  optionsConfig?: Record<
                      string,
                      { disabled?: boolean; parameters?: Record<string, any> },
                  >;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  isReadOnly?: boolean;
              },
          >,
      >

    • Parameters

      • Optionalquery: Omit<
            {
                limit?: number;
                cursor?: string;
                includeArchived?: boolean;
                search?: string;
                appUuid?: string;
                connectors?: number;
                externalApps?: number;
                websearch?: number;
                all?: number;
            },
            "limit",
        >

      Returns Promise<
          {
              connection?: {
                  type?: "connector"
                  | "mcp";
                  name: string;
                  key?: string;
                  isTest?: boolean;
                  connected?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  requestError?: ErrorDataSchema;
                  error?: ErrorDataSchema;
                  integrationId?: string;
                  connectorId?: string;
                  externalAppId?: string;
                  connectorVersion?: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  canTest?: boolean;
                  canRefreshCredentials?: boolean;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  buildingAgentSessionId?: string;
                  clientAction?: {
                      type: "connect" | "provide-input";
                      description: string;
                      uiUrl?: string;
                      agentInstructions?: string;
                      handoffAgentInstructions?: string;
                      reason?: "provide-input" | "authenticate" | "reauthenticate";
                  };
                  id: string;
                  userId: string;
                  tenantId?: string;
              };
              spec?: any;
              authOptions?: {
                  key: string;
                  type: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  title?: string;
                  description?: string;
                  inputSchema?: DataSchema;
                  ui?: { schema?: any; helpUri?: string };
              }[];
              id?: string;
              logoUri?: string;
              appUri?: string;
              isConnected?: boolean;
              connectorId?: string;
              connectorVersion?: string;
              oAuthCallbackUri?: string;
              parameters?: any;
              archivedAt?: string;
              hasMissingParameters?: boolean;
              hasDocumentation?: boolean;
              hasOperations?: boolean;
              operationsCount?: number;
              hasData?: boolean;
              dataCollectionsCount?: number;
              hasEvents?: boolean;
              eventsCount?: number;
              hasGlobalWebhooks?: boolean;
              hasUdm?: boolean;
              isTest?: boolean;
              externalAppId?: string;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              optionsConfig?: Record<
                  string,
                  { disabled?: boolean; parameters?: Record<string, any> },
              >;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              isReadOnly?: boolean;
          }[],
      >

    • Parameters

      • data: {
            logoUri?: string;
            externalAppId?: string;
            externalAppUuid?: string;
            appUuid?: string;
            oAuthCallbackUri?: string;
            logoBase64?: string;
            connectorVersion?: string;
            connectorId?: string;
            connectorUuid?: string;
            connectorKey?: string;
            parameters?: Record<string, any>;
            optionsConfig?: Record<
                string,
                { disabled?: boolean; parameters?: Record<string, any> },
            >;
            uuid?: string;
            key?: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            intent?: string;
        }

      Returns Promise<
          {
              connection?: {
                  type?: "connector"
                  | "mcp";
                  name: string;
                  key?: string;
                  isTest?: boolean;
                  connected?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  requestError?: ErrorDataSchema;
                  error?: ErrorDataSchema;
                  integrationId?: string;
                  connectorId?: string;
                  externalAppId?: string;
                  connectorVersion?: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  canTest?: boolean;
                  canRefreshCredentials?: boolean;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  buildingAgentSessionId?: string;
                  clientAction?: {
                      type: "connect" | "provide-input";
                      description: string;
                      uiUrl?: string;
                      agentInstructions?: string;
                      handoffAgentInstructions?: string;
                      reason?: "provide-input" | "authenticate" | "reauthenticate";
                  };
                  id: string;
                  userId: string;
                  tenantId?: string;
              };
              spec?: any;
              authOptions?: {
                  key: string;
                  type: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  title?: string;
                  description?: string;
                  inputSchema?: DataSchema;
                  ui?: { schema?: any; helpUri?: string };
              }[];
              id?: string;
              logoUri?: string;
              appUri?: string;
              isConnected?: boolean;
              connectorId?: string;
              connectorVersion?: string;
              oAuthCallbackUri?: string;
              parameters?: any;
              archivedAt?: string;
              hasMissingParameters?: boolean;
              hasDocumentation?: boolean;
              hasOperations?: boolean;
              operationsCount?: number;
              hasData?: boolean;
              dataCollectionsCount?: number;
              hasEvents?: boolean;
              eventsCount?: number;
              hasGlobalWebhooks?: boolean;
              hasUdm?: boolean;
              isTest?: boolean;
              externalAppId?: string;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              optionsConfig?: Record<
                  string,
                  { disabled?: boolean; parameters?: Record<string, any> },
              >;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              isReadOnly?: boolean;
          },
      >