Class IntegrationAccessor

actions

• get actions(): IntegrationLevelActionsListAccessor

  Returns IntegrationLevelActionsListAccessor

flows

• get flows(): IntegrationLevelFlowsListAccessor

  Returns IntegrationLevelFlowsListAccessor

dataSources

• get dataSources(): IntegrationLevelDataSourcesListAccessor

  Returns IntegrationLevelDataSourcesListAccessor

fieldMappings

• get fieldMappings(): IntegrationLevelFieldMappingsListAccessor

  Returns IntegrationLevelFieldMappingsListAccessor

constructor

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

  Parameters

  • client: MembraneApiClient
  • integrationSelector: string

  Returns IntegrationAccessor

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<
      {
          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;
          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";
          connection?: {
              id: 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>;
          };
          spec?: any;
          authOptions?: {
              key: string;
              type: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              title?: string;
              description?: string;
              ui?: { schema?: any; helpUri?: string };
          }[];
          parametersSchema?: DataSchema;
      },
  >

  Returns Promise<
      {
          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;
          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";
          connection?: {
              id: 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>;
          };
          spec?: any;
          authOptions?: {
              key: string;
              type: | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
              title?: string;
              description?: string;
              ui?: { schema?: any; helpUri?: string };
          }[];
          parametersSchema?: DataSchema;
      },
  >

getConnectorSpec

• getConnectorSpec(): Promise<ConnectionSpec>

  Returns Promise<ConnectionSpec>

open

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

  Parameters

  • Optional__namedParameters: OpenIntegrationUIIntegrationConfigurationOptions

  Returns Promise<void>

openNewConnection

• openNewConnection(
      __namedParameters?: OpenNewConnectionOptions,
  ): Promise<
      {
          id: 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>;
          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?: {
              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;
              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";
          };
      },
  >

  Parameters

  • Optional__namedParameters: OpenNewConnectionOptions

  Returns Promise<
      {
          id: 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>;
          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?: {
              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;
              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";
          };
      },
  >

connect

• connect(
      __namedParameters?: { name?: string | undefined; parameters?: any; connectorParameters?: any; authOptionKey?: string | undefined; allowMultipleConnections?: boolean | undefined; } & ({ sameWindow: true; redirectUri: string; } | { ...; }),
  ): Promise<
      | undefined
      | {
          id: string;
          name: string;
          userId: string;
          integrationId: string;
          createdAt: string;
          updatedAt: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: WorkspaceElementState;
          error?: ErrorDataSchema;
          authOptionKey?: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          user?: {
              id: string;
              name: string;
              internalId: string;
              meta?: Record<string, any>;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              createdAt?: string;
              archivedAt?: string;
          };
          integration?: {
              id: string;
              name: string;
              logoUri: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              state?: WorkspaceElementState;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: 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";
          };
      },
  >

  Parameters

  • Optional__namedParameters: { name?: string | undefined; parameters?: any; connectorParameters?: any; authOptionKey?: string | undefined; allowMultipleConnections?: boolean | undefined; } & ({ sameWindow: true; redirectUri: string; } | { ...; })

  Returns Promise<
      | undefined
      | {
          id: string;
          name: string;
          userId: string;
          integrationId: string;
          createdAt: string;
          updatedAt: string;
          isTest?: boolean;
          disconnected?: boolean;
          isDefunct?: boolean;
          state?: WorkspaceElementState;
          error?: ErrorDataSchema;
          authOptionKey?: string;
          lastActiveAt?: string;
          nextCredentialsRefreshAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          meta?: Record<string, any>;
          user?: {
              id: string;
              name: string;
              internalId: string;
              meta?: Record<string, any>;
              fields?: Record<string, any>;
              credentials?: any;
              lastActiveAt?: string;
              isTest?: boolean;
              isBillable?: boolean;
              createdAt?: string;
              archivedAt?: string;
          };
          integration?: {
              id: string;
              name: string;
              logoUri: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              state?: WorkspaceElementState;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: 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";
          };
      },
  >

createConnection

• createConnection(
      __namedParameters: { parameters?: any; name?: string },
  ): Promise<
      | undefined
      | {
          id: 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>;
          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?: {
              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;
              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";
          };
      },
  >

  Parameters

  • __namedParameters: { parameters?: any; name?: string }

  Returns Promise<
      | undefined
      | {
          id: 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>;
          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?: {
              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;
              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";
          };
      },
  >

getOperations

• getOperations(): Promise<OperationListItem[]>

  Returns Promise<OperationListItem[]>

getOperation

• getOperation(key: string): Promise<OperationSpec>

  Parameters

  • key: string

  Returns Promise<OperationSpec>

getDataCollections

• getDataCollections(): Promise<DataCollectionListItem[]>

  Returns Promise<DataCollectionListItem[]>

getDataCollection

• getDataCollection(
      key: string,
  ): Promise<
      {
          type: "collection";
          key?: string;
          name: string;
          parametersSchema?: DataSchema;
          fieldsSchema?: DataSchema;
          list?: {
              apiRequests?: { path: unknown; method: unknown }[];
              filterFields?: string[];
          };
          search?: { apiRequests?: { path: unknown; method: unknown }[] };
          match?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
          };
          findById?: { apiRequests?: { path: unknown; method: unknown }[] };
          create?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              requiredFields?: string[];
              excludedFields?: string[];
          };
          update?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              excludedFields?: string[];
          };
          delete?: { apiRequests?: { path: unknown; method: unknown }[] };
          events?: {
              created?: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              updated?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              deleted?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              all?: { type: "push"
              | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
              [key: string]: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
          };
          customFields?: boolean;
          udm?: Record<
              string,
              {
                  fields?: string[];
                  extract?: Record<string, any>;
                  parse?: Record<string, any>;
              },
          >;
          find?: {
              apiRequests?: { path: unknown; method: unknown }[];
              queryFields?: string[];
          };
      },
  >

  Parameters

  • key: string

  Returns Promise<
      {
          type: "collection";
          key?: string;
          name: string;
          parametersSchema?: DataSchema;
          fieldsSchema?: DataSchema;
          list?: {
              apiRequests?: { path: unknown; method: unknown }[];
              filterFields?: string[];
          };
          search?: { apiRequests?: { path: unknown; method: unknown }[] };
          match?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
          };
          findById?: { apiRequests?: { path: unknown; method: unknown }[] };
          create?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              requiredFields?: string[];
              excludedFields?: string[];
          };
          update?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              excludedFields?: string[];
          };
          delete?: { apiRequests?: { path: unknown; method: unknown }[] };
          events?: {
              created?: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              updated?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              deleted?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              all?: { type: "push"
              | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
              [key: string]: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
          };
          customFields?: boolean;
          udm?: Record<
              string,
              {
                  fields?: string[];
                  extract?: Record<string, any>;
                  parse?: Record<string, any>;
              },
          >;
          find?: {
              apiRequests?: { path: unknown; method: unknown }[];
              queryFields?: string[];
          };
      },
  >

baseUri