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

    Function useFlowInstances

    • Parameters

      • Optionalquery: {
            flowId?: string;
            flowKey?: string;
            enabled?: boolean;
            search?: string;
            limit?: number;
            cursor?: string;
            includeArchived?: boolean;
            userId?: string;
            instanceKey?: string;
            connectionId?: string;
            integrationId?: string;
            integrationKey?: string;
        }

      Returns {
          items: {
              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[];
              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;
              };
              connection?: {
                  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>;
              };
              flow?: {
                  id: string;
                  key?: string;
                  description?: string;
                  uuid?: string;
                  meta?: Record<string, 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?: ...; name?: ... }[];
                          isCustomized?: boolean;
                      },
                  >;
                  autoCreateInstances?: boolean;
                  name: string;
                  state?: CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isCustomized?: boolean;
                  universalFlowRevision?: 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";
                  };
                  appliedToIntegrations?: {
                      element: {
                          id: string;
                          integrationId?: string;
                          isCustomized?: boolean;
                          universalFlowId?: string;
                      };
                      integration: {
                          id: string;
                          key?: string;
                          uuid?: string;
                          description?: string;
                          meta?: Record<(...), (...)>;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: (...)[];
                          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";
                      };
                  }[];
                  dependencies?: any[];
              };
              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";
              };
          }[];
          refresh: () => Promise<void>;
          refreshing: boolean;
          loadMore: () => Promise<void>;
          loadingMore: boolean;
          loading: boolean;
          error: any;
          flowInstances: {
              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[];
              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;
              };
              connection?: {
                  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>;
              };
              flow?: {
                  id: string;
                  key?: string;
                  description?: string;
                  uuid?: string;
                  meta?: Record<string, 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?: ...; name?: ... }[];
                          isCustomized?: boolean;
                      },
                  >;
                  autoCreateInstances?: boolean;
                  name: string;
                  state?: CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isCustomized?: boolean;
                  universalFlowRevision?: 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";
                  };
                  appliedToIntegrations?: {
                      element: {
                          id: string;
                          integrationId?: string;
                          isCustomized?: boolean;
                          universalFlowId?: string;
                      };
                      integration: {
                          id: string;
                          key?: string;
                          uuid?: string;
                          description?: string;
                          meta?: Record<(...), (...)>;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: (...)[];
                          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";
                      };
                  }[];
                  dependencies?: any[];
              };
              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";
              };
          }[];
      }