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

  Parameters

  • actionSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelActionAccessor

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;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: 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;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

patch

• patch(
      data: { name?: string; credentials?: string; accessToken?: 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;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

  Parameters

  • data: { name?: string; credentials?: string; accessToken?: string }

    • Optionalname?: string

    • Optionalcredentials?: string

    • OptionalaccessToken?: string

      Deprecated

  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;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

put

• put(
      data: { name?: string; credentials?: string; accessToken?: 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;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

  Parameters

  • data: { name?: string; credentials?: string; accessToken?: string }

    • Optionalname?: string

    • Optionalcredentials?: string

    • OptionalaccessToken?: string

      Deprecated

  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;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

archive

• archive(): Promise<void>

  Returns Promise<void>

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;
      },
  ): Promise<
      | undefined
      | {
          user?: {
              id: string;
              name: string;
              meta?: Record<string, any>;
              internalId: string;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

  Parameters

  • __namedParameters: { parameters?: any; authOptionKey?: string; connectorParameters?: any } = {}

  Returns Promise<
      | undefined
      | {
          user?: {
              id: string;
              name: string;
              meta?: Record<string, any>;
              internalId: string;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              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;
              appUuid?: string;
              isDeactivated?: boolean;
              authType?: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
          };
          name: string;
          userId: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: CONFIGURATION_ERROR
          | SETUP_FAILED
          | READY;
          error?: ErrorDataSchema;
          integrationId: string;
          authOptionKey?: string;
          createdAt: string;
          updatedAt: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          id: string;
      },
  >

openReconnectUI

• openReconnectUI(__namedParameters?: OpenConfigurationOptions): Promise<void>

  Parameters

  • __namedParameters: OpenConfigurationOptions = {}

  Returns Promise<void>

refreshCredentials

• refreshCredentials(): Promise<void>

  Returns Promise<void>

getPath

• getPath(subpath?: string, query?: Record<string, any>): string

  Parameters

  • Optionalsubpath: string
  • Optionalquery: Record<string, any>

  Returns string