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

    Class ConnectionLevelFlowsAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    connectionSelector: string
    elementKey: string

    Methods

    • Parameters

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

      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;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<(...), (...)> },
                      >;
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
                  appliedToIntegrations?: {
                      element: {
                          connectionId?: string;
                          instanceKey?: string;
                          flowId?: string;
                          universalFlowId?: string;
                          parametersSchema?: DataSchema;
                          parameters?: any;
                          enabled?: boolean;
                          nodes?: Record<
                              string,
                              {
                                  type?: ...;
                                  version?: ...;
                                  name?: ...;
                                  description?: ...;
                                  config?: ...;
                                  concurrency?: ...;
                                  onError?: ...;
                                  ui?: ...;
                                  inputSchema?: ...;
                                  outputSchema?: ...;
                                  outputExample?: ...;
                                  links?: ...;
                                  isCustomized?: ...;
                                  state?: ...;
                                  errors?: ...;
                                  userConfig?: ...;
                                  testInput?: ...;
                                  dependencies?: ...;
                              },
                          >;
                          autoCreateInstances?: boolean;
                          flowRevision?: string;
                          universalFlowRevision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          state?: | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                          customized?: {
                              name?: (...)
                              | (...)
                              | (...);
                              nodes?: (...) | (...) | (...);
                          };
                          dependencies?: any[];
                          id: string;
                          uuid?: string;
                          key?: string;
                          description?: string;
                          meta?: Record<string, any>;
                          name: string;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          isReadOnly?: boolean;
                          integrationId?: string;
                          integrationUuid?: string;
                          integrationKey?: string;
                          parentUuid?: string;
                          parentKey?: string;
                          isUniversal?: boolean;
                          externalAppId?: string;
                          externalAppUuid?: string;
                          externalAppKey?: string;
                          isCustomized?: boolean;
                          userId?: string;
                          tenantId?: 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;
                          externalAppId?: string;
                          appUuid?: string;
                          isDeactivated?: boolean;
                          authType?: | "proxy"
                          | "integration-app-token"
                          | "membrane-token"
                          | "oauth2"
                          | "oauth1"
                          | "client-credentials";
                          optionsConfig?: Record<string, { disabled?: ...; parameters?: ... }>;
                          id: string;
                          uuid?: string;
                          key?: string;
                          description?: string;
                          meta?: Record<string, any>;
                          name: string;
                          state?:
                              | BUILDING
                              | CLIENT_ACTION_REQUIRED
                              | CONFIGURATION_ERROR
                              | SETUP_FAILED
                              | READY
                              | DISCONNECTING;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          isReadOnly?: boolean;
                      };
                  }[];
                  user?: {
                      id: string;
                      name: string;
                      meta?: Record<string, any>;
                      internalId: string;
                      fields?: Record<string, any>;
                      credentials?: any;
                      lastActiveAt?: string;
                      isTest?: boolean;
                      isBillable?: boolean;
                      isActive?: boolean;
                      aiCreditsRolling30DayLimit?: number | null;
                      createdAt?: string;
                      archivedAt?: string;
                  };
                  connection?: {
                      type?: "connector"
                      | "mcp";
                      name: string;
                      key?: string;
                      isTest?: boolean;
                      connected?: boolean;
                      disconnected?: boolean;
                      isDefunct?: boolean;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      requestError?: ErrorDataSchema;
                      error?: ErrorDataSchema;
                      integrationId?: string;
                      connectorId?: string;
                      externalAppId?: string;
                      connectorVersion?: string;
                      authOptionKey?: string;
                      createdAt: string;
                      updatedAt: string;
                      lastActiveAt?: string;
                      nextCredentialsRefreshAt?: string;
                      nextRetryTimestamp?: string;
                      retryAttempts?: number;
                      canTest?: boolean;
                      canRefreshCredentials?: boolean;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                      buildingAgentSessionId?: string;
                      clientAction?: {
                          type: "connect" | "provide-input";
                          description: string;
                          uiUrl?: string;
                          agentInstructions?: string;
                          handoffAgentInstructions?: string;
                          reason?: "provide-input" | "authenticate" | "reauthenticate";
                      };
                      id: string;
                      userId: string;
                      tenantId?: string;
                  };
                  flow?: {
                      connectionId?: string;
                      instanceKey?: string;
                      flowId?: string;
                      universalFlowId?: string;
                      parametersSchema?: DataSchema;
                      parameters?: any;
                      enabled?: boolean;
                      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?: (...)[];
                              isCustomized?: boolean;
                              state?: SETUP_FAILED | READY;
                              errors?: (...)[];
                              userConfig?: any;
                              testInput?: any;
                              dependencies?: (...)[];
                          },
                      >;
                      autoCreateInstances?: boolean;
                      flowRevision?: string;
                      universalFlowRevision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      state?: | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                      customized?: { name?: boolean; nodes?: boolean };
                      dependencies?: any[];
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                      isCustomized?: boolean;
                      userId?: string;
                      tenantId?: string;
                  };
                  connectionId?: string;
                  instanceKey?: string;
                  flowId?: string;
                  universalFlowId?: string;
                  parametersSchema?: DataSchema;
                  parameters?: any;
                  enabled?: boolean;
                  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;
                          state?: SETUP_FAILED | READY;
                          errors?: ErrorDataSchema[];
                          userConfig?: any;
                          testInput?: any;
                          dependencies?: any[];
                      },
                  >;
                  autoCreateInstances?: boolean;
                  flowRevision?: string;
                  universalFlowRevision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  state?: | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
                  customized?: { name?: boolean; nodes?: boolean };
                  dependencies?: any[];
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isReadOnly?: boolean;
                  integrationId?: string;
                  integrationUuid?: string;
                  integrationKey?: string;
                  parentUuid?: string;
                  parentKey?: string;
                  isUniversal?: boolean;
                  externalAppId?: string;
                  externalAppUuid?: string;
                  externalAppKey?: string;
                  isCustomized?: boolean;
                  userId?: string;
                  tenantId?: string;
              }[],
          >,
      >