Class FlowRunAccessor

constructor

• new FlowRunAccessor(client: MembraneApiClient, id: string): FlowRunAccessor

  Parameters

  • client: MembraneApiClient
  • id: string

  Returns FlowRunAccessor

id

get

• get(): 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[] };
      },
  >

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

stop

• stop(): Promise<void>

  Returns Promise<void>

getOutput

• getOutput(): Promise<any>

  Returns Promise<any>

getNodeRuns

• getNodeRuns(nodeKey: string, parameters?: { cursor?: string }): Promise<any>

  Parameters

  • nodeKey: string
  • Optionalparameters: { cursor?: string }

  Returns Promise<any>

getNodeRun

• getNodeRun(nodeKey: string, runId: string): Promise<any>

  Parameters

  • nodeKey: string
  • runId: string

  Returns Promise<any>

getNodeOutputs

• getNodeOutputs(nodeKey: string, parameters?: { cursor?: string }): Promise<any>

  Parameters

  • nodeKey: string
  • Optionalparameters: { cursor?: string }

  Returns Promise<any>

getNodeOutput

• getNodeOutput(nodeKey: string, outputId: string): Promise<any>

  Parameters

  • nodeKey: string
  • outputId: string

  Returns Promise<any>

repeat

• repeat(): 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[] };
      },
  >

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

openEditor

• openEditor(__namedParameters?: OpenFlowRunEditorOptions): Promise<void>

  Parameters

  • __namedParameters: OpenFlowRunEditorOptions = {}

  Returns Promise<void>

embedEditor

• embedEditor(
      __namedParameters?: { mountTargetSelector?: string } & OpenFlowRunEditorOptions,
  ): Promise<void>

  Parameters

  • __namedParameters: { mountTargetSelector?: string } & OpenFlowRunEditorOptions = {}

  Returns Promise<void>