Class ConnectionLevelFlowAccessor

constructor

• new ConnectionLevelFlowAccessor(
      client: MembraneApiClient,
      connectionSelector: string,
      flowSelector: string,
      query: InstanceKeyQuery,
  ): ConnectionLevelFlowAccessor

  Parameters

  • client: MembraneApiClient
  • connectionSelector: string
  • flowSelector: string
  • query: InstanceKeyQuery

  Returns ConnectionLevelFlowAccessor

flowSelector

enable

• enable(): 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;
          };
          connection?: {
              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;
          };
          flow?: {
              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;
              };
              appliedToIntegrations?: {
                  element: {
                      id: string;
                      integrationId?: string;
                      isCustomized?: boolean;
                      universalFlowId?: 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;
                  };
              }[];
              dependencies?: any[];
              integrationId?: string;
              universalFlowId?: string;
              parametersSchema?: DataSchema;
              nodes?: Record<
                  string,
                  {
                      type?: string;
                      version?: number;
                      name?: string;
                      description?: string;
                      config?: any;
                      concurrency?: number;
                      onError?: "continue"
                      | "stop";
                      ui?: any;
                      inputSchema?: any;
                      outputSchema?: any;
                      outputExample?: any;
                      links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                      isCustomized?: boolean;
                  },
              >;
              autoCreateInstances?: boolean;
              universalFlowRevision?: 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;
          };
          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;
          };
          userId: string;
          connectionId?: string;
          flowId?: string;
          universalFlowId?: string;
          integrationId: string;
          instanceKey?: string;
          parameters?: any;
          parametersSchema?: DataSchema;
          nodes?: Record<string, any>;
          enabled: boolean;
          createdAt: string;
          updatedAt: string;
          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
          customized?: { name?: boolean; nodes?: boolean };
          dependencies?: any[];
          id: string;
          key?: string;
          uuid?: string;
          description?: string;
          meta?: Record<string, any>;
          name: string;
          errors?: ErrorDataSchema[];
          revision?: string;
          archivedAt?: string;
          isDeactivated?: 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;
          };
          connection?: {
              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;
          };
          flow?: {
              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;
              };
              appliedToIntegrations?: {
                  element: {
                      id: string;
                      integrationId?: string;
                      isCustomized?: boolean;
                      universalFlowId?: 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;
                  };
              }[];
              dependencies?: any[];
              integrationId?: string;
              universalFlowId?: string;
              parametersSchema?: DataSchema;
              nodes?: Record<
                  string,
                  {
                      type?: string;
                      version?: number;
                      name?: string;
                      description?: string;
                      config?: any;
                      concurrency?: number;
                      onError?: "continue"
                      | "stop";
                      ui?: any;
                      inputSchema?: any;
                      outputSchema?: any;
                      outputExample?: any;
                      links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                      isCustomized?: boolean;
                  },
              >;
              autoCreateInstances?: boolean;
              universalFlowRevision?: 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;
          };
          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;
          };
          userId: string;
          connectionId?: string;
          flowId?: string;
          universalFlowId?: string;
          integrationId: string;
          instanceKey?: string;
          parameters?: any;
          parametersSchema?: DataSchema;
          nodes?: Record<string, any>;
          enabled: boolean;
          createdAt: string;
          updatedAt: string;
          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
          customized?: { name?: boolean; nodes?: boolean };
          dependencies?: any[];
          id: string;
          key?: string;
          uuid?: string;
          description?: string;
          meta?: Record<string, any>;
          name: string;
          errors?: ErrorDataSchema[];
          revision?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
      },
  >

disable

• disable(): 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;
          };
          connection?: {
              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;
          };
          flow?: {
              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;
              };
              appliedToIntegrations?: {
                  element: {
                      id: string;
                      integrationId?: string;
                      isCustomized?: boolean;
                      universalFlowId?: 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;
                  };
              }[];
              dependencies?: any[];
              integrationId?: string;
              universalFlowId?: string;
              parametersSchema?: DataSchema;
              nodes?: Record<
                  string,
                  {
                      type?: string;
                      version?: number;
                      name?: string;
                      description?: string;
                      config?: any;
                      concurrency?: number;
                      onError?: "continue"
                      | "stop";
                      ui?: any;
                      inputSchema?: any;
                      outputSchema?: any;
                      outputExample?: any;
                      links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                      isCustomized?: boolean;
                  },
              >;
              autoCreateInstances?: boolean;
              universalFlowRevision?: 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;
          };
          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;
          };
          userId: string;
          connectionId?: string;
          flowId?: string;
          universalFlowId?: string;
          integrationId: string;
          instanceKey?: string;
          parameters?: any;
          parametersSchema?: DataSchema;
          nodes?: Record<string, any>;
          enabled: boolean;
          createdAt: string;
          updatedAt: string;
          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
          customized?: { name?: boolean; nodes?: boolean };
          dependencies?: any[];
          id: string;
          key?: string;
          uuid?: string;
          description?: string;
          meta?: Record<string, any>;
          name: string;
          errors?: ErrorDataSchema[];
          revision?: string;
          archivedAt?: string;
          isDeactivated?: 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;
          };
          connection?: {
              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;
          };
          flow?: {
              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;
              };
              appliedToIntegrations?: {
                  element: {
                      id: string;
                      integrationId?: string;
                      isCustomized?: boolean;
                      universalFlowId?: 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;
                  };
              }[];
              dependencies?: any[];
              integrationId?: string;
              universalFlowId?: string;
              parametersSchema?: DataSchema;
              nodes?: Record<
                  string,
                  {
                      type?: string;
                      version?: number;
                      name?: string;
                      description?: string;
                      config?: any;
                      concurrency?: number;
                      onError?: "continue"
                      | "stop";
                      ui?: any;
                      inputSchema?: any;
                      outputSchema?: any;
                      outputExample?: any;
                      links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                      isCustomized?: boolean;
                  },
              >;
              autoCreateInstances?: boolean;
              universalFlowRevision?: 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;
          };
          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;
          };
          userId: string;
          connectionId?: string;
          flowId?: string;
          universalFlowId?: string;
          integrationId: string;
          instanceKey?: string;
          parameters?: any;
          parametersSchema?: DataSchema;
          nodes?: Record<string, any>;
          enabled: boolean;
          createdAt: string;
          updatedAt: string;
          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
          customized?: { name?: boolean; nodes?: boolean };
          dependencies?: any[];
          id: string;
          key?: string;
          uuid?: string;
          description?: string;
          meta?: Record<string, any>;
          name: string;
          errors?: ErrorDataSchema[];
          revision?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
      },
  >

run

• run(
      options: { nodeKey?: string; input?: any },
  ): Promise<
      {
          flowInstance?: {
              userId: string;
              connectionId?: string;
              flowId?: string;
              universalFlowId?: string;
              integrationId: string;
              instanceKey?: string;
              parameters?: any;
              parametersSchema?: DataSchema;
              nodes?: Record<string, any>;
              enabled: boolean;
              createdAt: string;
              updatedAt: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              customized?: { name?: boolean; nodes?: boolean };
              dependencies?: any[];
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              errors?: ErrorDataSchema[];
              revision?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          };
          connection?: {
              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;
          };
          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;
          };
          id: string;
          name?: string;
          flowInstanceId: string;
          universalFlowId?: string;
          connectionId?: string;
          integrationId?: string;
          startNodeKey: string;
          userId: string;
          input?: any;
          state: FlowRunState;
          startTime: string;
          endTime?: string;
          errors?: ErrorDataSchema[];
          nodes?: Record<
              string,
              {
                  state: FlowRunNodeState;
                  runs?: number;
                  erroredRuns?: number;
                  outputs?: number;
              },
          >;
          launchedBy?: { type: FlowRunLaunchedByTrigger; ids?: string[] };
      },
  >

  Parameters

  • options: { nodeKey?: string; input?: any }

  Returns Promise<
      {
          flowInstance?: {
              userId: string;
              connectionId?: string;
              flowId?: string;
              universalFlowId?: string;
              integrationId: string;
              instanceKey?: string;
              parameters?: any;
              parametersSchema?: DataSchema;
              nodes?: Record<string, any>;
              enabled: boolean;
              createdAt: string;
              updatedAt: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              customized?: { name?: boolean; nodes?: boolean };
              dependencies?: any[];
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              errors?: ErrorDataSchema[];
              revision?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          };
          connection?: {
              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;
          };
          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;
          };
          id: string;
          name?: string;
          flowInstanceId: string;
          universalFlowId?: string;
          connectionId?: string;
          integrationId?: string;
          startNodeKey: string;
          userId: string;
          input?: any;
          state: FlowRunState;
          startTime: string;
          endTime?: string;
          errors?: ErrorDataSchema[];
          nodes?: Record<
              string,
              {
                  state: FlowRunNodeState;
                  runs?: number;
                  erroredRuns?: number;
                  outputs?: number;
              },
          >;
          launchedBy?: { type: FlowRunLaunchedByTrigger; ids?: string[] };
      },
  >

openConfiguration

• openConfiguration(options?: OpenFlowInstanceConfigurationOptions): Promise<void>

  Parameters

  • Optionaloptions: OpenFlowInstanceConfigurationOptions

  Returns Promise<void>

openEditor

• openEditor(options?: OpenFlowInstanceEditorOptions): Promise<void>

  Parameters

  • Optionaloptions: OpenFlowInstanceEditorOptions

  Returns Promise<void>