Class IntegrationAccessor

constructor

• new IntegrationAccessor(
      client: MembraneApiClient,
      integrationSelector: string,
  ): IntegrationAccessor

  Parameters

  • client: MembraneApiClient
  • integrationSelector: string

  Returns IntegrationAccessor

baseUri

actions

• get actions(): IntegrationLevelActionsListAccessor

  Returns IntegrationLevelActionsListAccessor

flows

• get flows(): IntegrationLevelFlowsListAccessor

  Returns IntegrationLevelFlowsListAccessor

dataSources

• get dataSources(): IntegrationLevelDataSourcesListAccessor

  Returns IntegrationLevelDataSourcesListAccessor

fieldMappings

• get fieldMappings(): IntegrationLevelFieldMappingsListAccessor

  Returns IntegrationLevelFieldMappingsListAccessor

action

• action(actionSelector: string): IntegrationLevelActionAccessor

  Parameters

  • actionSelector: string

  Returns IntegrationLevelActionAccessor

flow

• flow(flowSelector: string): IntegrationLevelFlowAccessor

  Parameters

  • flowSelector: string

  Returns IntegrationLevelFlowAccessor

dataSource

• dataSource(dataSourceSelector: string): IntegrationLevelDataSourceAccessor

  Parameters

  • dataSourceSelector: string

  Returns IntegrationLevelDataSourceAccessor

fieldMapping

• fieldMapping(fieldMappingSelector: string): IntegrationLevelFieldMappingAccessor

  Parameters

  • fieldMappingSelector: string

  Returns IntegrationLevelFieldMappingAccessor

setup

• setup(): 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;
      },
  >

  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;
      },
  >

getConnectorSpec

• getConnectorSpec(): Promise<ConnectionSpec>

  Returns Promise<ConnectionSpec>

open

• open(
      __namedParameters?: OpenIntegrationUIIntegrationConfigurationOptions,
  ): Promise<void>

  Show integration UI to your user.

  Parameters

  • __namedParameters: OpenIntegrationUIIntegrationConfigurationOptions = {}

  Returns Promise<void>

openNewConnection

• openNewConnection(
      __namedParameters?: OpenNewConnectionOptions,
  ): Promise<
      | {
          user?: {
              id: string;
              name: string;
              meta?: Record<string, any>;
              internalId: string;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              isActive?: boolean;
              aiCreditsRolling30DayLimit?: number | null;
              createdAt?: string;
              archivedAt?: string;
          };
          integration?: {
              logoUri: string;
              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> },
              >;
              id: string;
              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;
          };
          connectorParameters?: unknown;
          input?: unknown;
          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;
      }
      | null,
  >

  Shows UI to create a new connection for this integration or refresh an existing one. Returns promise with a new connection or null if the user cancels the connection flow.

  Parameters

  • __namedParameters: OpenNewConnectionOptions = {}

  Returns Promise<
      | {
          user?: {
              id: string;
              name: string;
              meta?: Record<string, any>;
              internalId: string;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              isActive?: boolean;
              aiCreditsRolling30DayLimit?: number | null;
              createdAt?: string;
              archivedAt?: string;
          };
          integration?: {
              logoUri: string;
              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> },
              >;
              id: string;
              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;
          };
          connectorParameters?: unknown;
          input?: unknown;
          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;
      }
      | null,
  >

  Deprecated

  Use client.ui.connect({ integrationKey }) instead

openNewConnectionV2

• openNewConnectionV2(
      __namedParameters?: OpenNewConnectionOptions,
  ): Promise<
      | {
          user?: {
              id: string;
              name: string;
              meta?: Record<string, any>;
              internalId: string;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              isActive?: boolean;
              aiCreditsRolling30DayLimit?: number | null;
              createdAt?: string;
              archivedAt?: string;
          };
          integration?: {
              logoUri: string;
              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> },
              >;
              id: string;
              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;
          };
          connectorParameters?: unknown;
          input?: unknown;
          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;
      }
      | null,
  >

  Shows UI to create a new connection using the new SSR-based screens. Returns promise with a new connection or null if the user cancels the connection flow.

  Parameters

  • __namedParameters: OpenNewConnectionOptions = {}

  Returns Promise<
      | {
          user?: {
              id: string;
              name: string;
              meta?: Record<string, any>;
              internalId: string;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              isActive?: boolean;
              aiCreditsRolling30DayLimit?: number | null;
              createdAt?: string;
              archivedAt?: string;
          };
          integration?: {
              logoUri: string;
              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> },
              >;
              id: string;
              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;
          };
          connectorParameters?: unknown;
          input?: unknown;
          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;
      }
      | null,
  >

  Deprecated

  Use client.ui.connect({ integrationKey }) instead