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

    Class IntegrationLevelActionsListAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client integrationSelector endpoint elementKey

    Methods

    list create

    Constructors

    Properties

    client: MembraneApiClient
    integrationSelector: string
    endpoint: string
    elementKey: string

    Methods

    • Parameters

      • Optionalquery: Omit<
            {
                limit?: number;
                cursor?: string;
                integrationId?: string;
                parentId?: string;
                universalParentId?: string;
                integrationKey?: string;
                search?: string;
                includeArchived?: boolean;
                userId?: string;
                connectionId?: string;
            },
            "integrationId",
        >

      Returns Promise<
          PaginationResponse<
              {
                  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;
                  };
                  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;
                  };
                  parent?: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isCustomized?: boolean;
                  };
                  appliedToIntegrations?: {
                      element: {
                          integrationId?: string;
                          connectionId?: string;
                          parentId?: string;
                          instanceKey?: string;
                          inputSchema?: DataSchema;
                          type?: | ListDataRecords
                          | FindDataRecordById
                          | MatchDataRecord
                          | CreateDataRecord
                          | FindOrCreateDataRecord
                          | UpdateDataRecord
                          | DeleteDataRecord
                          | SearchDataRecords
                          | ConnectorOperation
                          | ApiRequestToExternalApp
                          | ApiRequestToYourApp
                          | HttpRequest
                          | RunJavascript
                          | ApiRequest;
                          config?: any;
                          outputMapping?: any;
                          customOutputSchema?: DataSchema;
                          universalParentId?: string;
                          userId?: string;
                          outputSchema?: any;
                          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;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          isCustomized?: boolean;
                      };
                      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;
                      };
                  }[];
                  defaultOutputSchema?: DataSchema;
                  transformedOutputSchema?: DataSchema;
                  outputSchema?: DataSchema;
                  dependencies?: any[];
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  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;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isCustomized?: boolean;
              },
          >,
      >

    • Parameters

      Returns Promise<
          {
              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;
              };
              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;
              };
              parent?: {
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  outputSchema?: any;
                  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;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isCustomized?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isCustomized?: boolean;
                  };
                  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;
                  };
              }[];
              defaultOutputSchema?: DataSchema;
              transformedOutputSchema?: DataSchema;
              outputSchema?: DataSchema;
              dependencies?: any[];
              integrationId?: string;
              connectionId?: string;
              parentId?: string;
              instanceKey?: string;
              inputSchema?: DataSchema;
              type?: | ListDataRecords
              | FindDataRecordById
              | MatchDataRecord
              | CreateDataRecord
              | FindOrCreateDataRecord
              | UpdateDataRecord
              | DeleteDataRecord
              | SearchDataRecords
              | ConnectorOperation
              | ApiRequestToExternalApp
              | ApiRequestToYourApp
              | HttpRequest
              | RunJavascript
              | ApiRequest;
              config?: any;
              outputMapping?: any;
              customOutputSchema?: DataSchema;
              universalParentId?: string;
              userId?: string;
              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;
              archivedAt?: string;
              isDeactivated?: boolean;
              isCustomized?: boolean;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods