Class ConnectionAccessor

constructor

• new ConnectionAccessor(
      client: MembraneApiClient,
      connectionSelector: string,
  ): ConnectionAccessor

  Parameters

  • client: MembraneApiClient
  • connectionSelector: string

  Returns ConnectionAccessor

client

connectionSelector

actions

• get actions(): ConnectionLevelActionsAccessor

  Returns ConnectionLevelActionsAccessor

flows

• get flows(): ConnectionLevelFlowsAccessor

  Returns ConnectionLevelFlowsAccessor

dataSources

• get dataSources(): ConnectionLevelDataSourcesAccessor

  Returns ConnectionLevelDataSourcesAccessor

fieldMappings

• get fieldMappings(): ConnectionLevelFieldMappingsAccessor

  Returns ConnectionLevelFieldMappingsAccessor

proxy

• get proxy(): ConnectionProxy

  Returns ConnectionProxy

action

• action(
      actionSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelActionAccessor<any, any>

  Parameters

  • actionSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelActionAccessor<any, any>

flow

• flow(
      flowSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelFlowAccessor

  Parameters

  • flowSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelFlowAccessor

dataSource

• dataSource(
      dataSourceSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelDataSourceAccessor

  Parameters

  • dataSourceSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelDataSourceAccessor

fieldMapping

• fieldMapping(
      fieldMappingSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelFieldMappingAccessor

  Parameters

  • fieldMappingSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelFieldMappingAccessor

get

• get(
      query?: { includeSecrets?: boolean },
  ): 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;
      },
  >

  Parameters

  • query: { includeSecrets?: boolean } = ...

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

patch

• patch(
      data: {
          type?: "connector" | "mcp";
          name?: string;
          meta?: Record<string, any>;
          authOptionKey?: string;
          key?: string | null;
          integrationId?: string;
          integrationUuid?: string;
          integrationKey?: string;
          connectorId?: string;
          connectorUuid?: string;
          connectorKey?: string;
          connectorVersion?: string;
          externalAppId?: string;
          externalAppUuid?: string;
          credentials?: unknown;
          connectorParameters?: unknown;
          input?: unknown;
          intent?: string;
      },
  ): 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;
      },
  >

  Parameters

  • data: {
        type?: "connector" | "mcp";
        name?: string;
        meta?: Record<string, any>;
        authOptionKey?: string;
        key?: string | null;
        integrationId?: string;
        integrationUuid?: string;
        integrationKey?: string;
        connectorId?: string;
        connectorUuid?: string;
        connectorKey?: string;
        connectorVersion?: string;
        externalAppId?: string;
        externalAppUuid?: string;
        credentials?: unknown;
        connectorParameters?: unknown;
        input?: unknown;
        intent?: string;
    }

    • Optionaltype?: "connector" | "mcp"

    • Optionalname?: string

    • Optionalmeta?: Record<string, any>

    • OptionalauthOptionKey?: string

    • Optionalkey?: string | null

      Stable, human-readable key for addressing this connection. Must be unique per tenant (workspace + tenantId scope). Mirrors the key field on the connection response so PATCH/PUT bodies look the same shape as what GET /connections/:id returns.

    • OptionalintegrationId?: string

    • OptionalintegrationUuid?: string

    • OptionalintegrationKey?: string

    • OptionalconnectorId?: string

    • OptionalconnectorUuid?: string

    • OptionalconnectorKey?: string

    • OptionalconnectorVersion?: string

    • OptionalexternalAppId?: string

    • OptionalexternalAppUuid?: string

    • Optionalcredentials?: unknown

    • OptionalconnectorParameters?: unknown

    • Optionalinput?: unknown

    • Optionalintent?: string

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

put

• put(
      data: {
          type?: "connector" | "mcp";
          name?: string;
          meta?: Record<string, any>;
          authOptionKey?: string;
          key?: string | null;
          integrationId?: string;
          integrationUuid?: string;
          integrationKey?: string;
          connectorId?: string;
          connectorUuid?: string;
          connectorKey?: string;
          connectorVersion?: string;
          externalAppId?: string;
          externalAppUuid?: string;
          credentials?: unknown;
          connectorParameters?: unknown;
          input?: unknown;
          intent?: string;
      },
  ): 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;
      },
  >

  Parameters

  • data: {
        type?: "connector" | "mcp";
        name?: string;
        meta?: Record<string, any>;
        authOptionKey?: string;
        key?: string | null;
        integrationId?: string;
        integrationUuid?: string;
        integrationKey?: string;
        connectorId?: string;
        connectorUuid?: string;
        connectorKey?: string;
        connectorVersion?: string;
        externalAppId?: string;
        externalAppUuid?: string;
        credentials?: unknown;
        connectorParameters?: unknown;
        input?: unknown;
        intent?: string;
    }

    • Optionaltype?: "connector" | "mcp"

    • Optionalname?: string

    • Optionalmeta?: Record<string, any>

    • OptionalauthOptionKey?: string

    • Optionalkey?: string | null

      Stable, human-readable key for addressing this connection. Must be unique per tenant (workspace + tenantId scope). Mirrors the key field on the connection response so PATCH/PUT bodies look the same shape as what GET /connections/:id returns.

    • OptionalintegrationId?: string

    • OptionalintegrationUuid?: string

    • OptionalintegrationKey?: string

    • OptionalconnectorId?: string

    • OptionalconnectorUuid?: string

    • OptionalconnectorKey?: string

    • OptionalconnectorVersion?: string

    • OptionalexternalAppId?: string

    • OptionalexternalAppUuid?: string

    • Optionalcredentials?: unknown

    • OptionalconnectorParameters?: unknown

    • Optionalinput?: unknown

    • Optionalintent?: string

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

archive

• archive(): Promise<void>

  Returns Promise<void>

restore

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

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

request

• request(path: string, data?: any): Promise<any>

  Parameters

  • path: string
  • data: any = null

  Returns Promise<any>

operation

• operation(key: string): ConnectionOperationAccessor

  Parameters

  • key: string

  Returns ConnectionOperationAccessor

dataCollection

• dataCollection(
      key: string,
      parameters?: Record<string, any>,
  ): ConnectionDataCollectionAccessor

  Parameters

  • key: string
  • Optionalparameters: Record<string, any>

  Returns ConnectionDataCollectionAccessor

reconnect

• reconnect(
      __namedParameters?: {
          parameters?: any;
          authOptionKey?: string;
          connectorParameters?: any;
          onPopupClosed?: () => void;
      },
  ): 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,
  >

  Reconnects an existing connection programmatically.

  Parameters

  • __namedParameters: {
        parameters?: any;
        authOptionKey?: string;
        connectorParameters?: any;
        onPopupClosed?: () => void;
    } = {}

  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.connect({ connectionId }) instead

openReconnectUI

• openReconnectUI(
      _options?: OpenConfigurationOptions,
  ): 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,
  >

  Opens the reconnect UI for this connection.

  Parameters

  • _options: OpenConfigurationOptions = {}

  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({ connectionId }) instead