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

    Class FlowsAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    find findAll create

    Constructors

    Methods

    • Parameters

      • Optionalquery: {
            limit?: number;
            cursor?: string;
            integrationId?: string;
            integrationKey?: string;
            universalFlowId?: string;
            search?: string;
            includeArchived?: 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;
                      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?: string; filter?: any; name?: string }[];
                          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;
              },
          >,
      >

    • Parameters

      • Optionalquery: Omit<
            {
                limit?: number;
                cursor?: string;
                integrationId?: string;
                integrationKey?: string;
                universalFlowId?: string;
                search?: string;
                includeArchived?: boolean;
            },
            "limit",
        >

      Returns Promise<
          {
              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?: string; filter?: any; name?: string }[];
                      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;
          }[],
      >

    • Parameters

      • data: {
            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?: string; filter?: any; name?: string }[];
                    isCustomized?: boolean;
                },
            >;
            autoCreateInstances?: boolean;
            key?: string;
            name?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
        }
        • OptionalintegrationId?: string
        • OptionaluniversalFlowId?: string
        • OptionalparametersSchema?: DataSchema

          DataSchema of parameters provided during the flow creation. Can be used to configure the flow logic.

        • Optionalnodes?: 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?: string; filter?: any; name?: string }[];
                  isCustomized?: boolean;
              },
          >

          Flow Nodes in the format :

        • OptionalautoCreateInstances?: boolean

          Automatically create a Flow Instance when a Connection is created.

        • Optionalkey?: string
        • Optionalname?: string
        • Optionaluuid?: string
        • Optionaldescription?: string
        • Optionalmeta?: Record<string, any>

      Returns Promise<
          {
              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?: string; filter?: any; name?: string }[];
                      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;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods