Membrane React - v0.6.0
    Preparing search index...

    Function useFlowRun

    • Parameters

      • id: undefined | string

      Returns {
          flowRun:
              | undefined
              | {
                  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[] };
                  flowInstance?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      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[];
                  };
                  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>;
                  };
                  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";
                  };
                  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;
                  };
              };
          error: any;
          loading: boolean;
          refresh: () => Promise<
              {
                  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[] };
                  flowInstance?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      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[];
                  };
                  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>;
                  };
                  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";
                  };
                  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;
                  };
              },
          >;
          archive: () => Promise<void>;
      }