Class FlowInstanceAccessor

Hierarchy (View Summary)

ElementInstanceAccessor<
    FlowInstance,
    FlowInstanceSelector,
    CreateFlowInstanceRequest,
    UpdateFlowInstanceRequest,
>
- FlowInstanceAccessor

Index

Constructors

Methods

getUniqueIdentifier get getId create put patch archive delete restore getPath enable disable updateToLatestFlow setup reset openConfiguration openEditor embedEditor startRun run

Properties

options client selector

Constructors

constructor

new FlowInstanceAccessor(
client: IntegrationAppApiClient,
selector: string | FlowInstanceSelector,
): FlowInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | FlowInstanceSelector
Returns FlowInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2604

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:317

get

get(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.get
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:318

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:319

create

create(
    data?: {
        name?: string;
        userId?: string;
        integrationId?: string;
        connectionId?: string;
        parameters?: any;
        flowId?: string;
        instanceKey?: string;
        nodes?: Record<
            string,
            {
                concurrency?: number;
                type?: string;
                name?: string;
                userConfig?: any;
                config?: any;
                onError?: "stop"
                | "continue";
                ui?: any;
                links?: { key?: string; name?: string; filter?: any }[];
                isCustomized?: boolean;
            },
        >;
        enabled?: boolean;
        customized?: { name?: boolean; nodes?: boolean };
    },
): Promise<FlowInstance>
Parameters
- Optionaldata: {
      name?: string;
      userId?: string;
      integrationId?: string;
      connectionId?: string;
      parameters?: any;
      flowId?: string;
      instanceKey?: string;
      nodes?: Record<
          string,
          {
              concurrency?: number;
              type?: string;
              name?: string;
              userConfig?: any;
              config?: any;
              onError?: "stop"
              | "continue";
              ui?: any;
              links?: { key?: string; name?: string; filter?: any }[];
              isCustomized?: boolean;
          },
      >;
      enabled?: boolean;
      customized?: { name?: boolean; nodes?: boolean };
  }
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.create
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:320

put

put(
    data: {
        name?: string;
        userId?: string;
        integrationId?: string;
        connectionId?: string;
        parameters?: any;
        flowId?: string;
        instanceKey?: string;
        nodes?: Record<
            string,
            {
                concurrency?: number;
                type?: string;
                name?: string;
                userConfig?: any;
                config?: any;
                onError?: "stop"
                | "continue";
                ui?: any;
                links?: { key?: string; name?: string; filter?: any }[];
                isCustomized?: boolean;
            },
        >;
        enabled?: boolean;
        customized?: { name?: boolean; nodes?: boolean };
    },
): Promise<FlowInstance>
Parameters
- data: {
      name?: string;
      userId?: string;
      integrationId?: string;
      connectionId?: string;
      parameters?: any;
      flowId?: string;
      instanceKey?: string;
      nodes?: Record<
          string,
          {
              concurrency?: number;
              type?: string;
              name?: string;
              userConfig?: any;
              config?: any;
              onError?: "stop"
              | "continue";
              ui?: any;
              links?: { key?: string; name?: string; filter?: any }[];
              isCustomized?: boolean;
          },
      >;
      enabled?: boolean;
      customized?: { name?: boolean; nodes?: boolean };
  }
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.put
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:321

patch

patch(
    data: {
        name?: string;
        parameters?: any;
        nodes?: Record<
            string,
            {
                concurrency?: number;
                type?: string;
                name?: string;
                userConfig?: any;
                config?: any;
                onError?: "stop"
                | "continue";
                links?: { key?: string; name?: string; filter?: any }[];
                isCustomized?: boolean;
            },
        >;
        enabled?: boolean;
        customized?: { name?: boolean; nodes?: boolean };
        archivedAt?: string;
    },
): Promise<FlowInstance>
Parameters
- data: {
      name?: string;
      parameters?: any;
      nodes?: Record<
          string,
          {
              concurrency?: number;
              type?: string;
              name?: string;
              userConfig?: any;
              config?: any;
              onError?: "stop"
              | "continue";
              links?: { key?: string; name?: string; filter?: any }[];
              isCustomized?: boolean;
          },
      >;
      enabled?: boolean;
      customized?: { name?: boolean; nodes?: boolean };
      archivedAt?: string;
  }
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:322

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.delete
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:324

restore

restore(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.restore
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:325

`Protected`getPath

getPath(operation?: string): string
Parameters
- Optionaloperation: string
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:326

enable

enable(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2605

disable

disable(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2606

updateToLatestFlow

updateToLatestFlow(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2607

setup

setup(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2608

reset

reset(options?: ResetFlowInstanceOptions): Promise<FlowInstance>
Parameters
- Optionaloptions: ResetFlowInstanceOptions
Returns Promise<FlowInstance>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2609

openConfiguration

openConfiguration(
__namedParameters?: OpenFlowInstanceConfigurationOptions,
): Promise<void>
Parameters
- Optional__namedParameters: OpenFlowInstanceConfigurationOptions
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2610

openEditor

openEditor(__namedParameters?: OpenFlowInstanceEditorOptions): Promise<void>
Parameters
- Optional__namedParameters: OpenFlowInstanceEditorOptions
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2611

embedEditor

embedEditor(
__namedParameters?: { mountTargetSelector?: string } & OpenFlowInstanceEditorOptions,
): Promise<void>
Parameters
- Optional__namedParameters: { mountTargetSelector?: string } & OpenFlowInstanceEditorOptions
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2612

startRun

startRun(options?: RunFlowOptions): Promise<FlowRun>
Parameters
- Optionaloptions: RunFlowOptions
Returns Promise<FlowRun>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2615

run

run(options?: RunFlowOptions): Promise<FlowRun>
Parameters
- Optionaloptions: RunFlowOptions
Returns Promise<FlowRun>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:2616

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    instancePath: string;
    selector: string | FlowInstanceSelector;
    type?: WorkspaceElementType;
}

`Protected`client

client: IntegrationAppApiClient

`Protected`selector

selector: string | FlowInstanceSelector

Class FlowInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns FlowInstanceAccessor

Methods

getUniqueIdentifier

Returns string

get

Returns Promise<FlowInstance>

getId

Returns Promise<string>

create

Parameters

Returns Promise<FlowInstance>

put

Parameters

Returns Promise<FlowInstance>

patch

Parameters

Returns Promise<FlowInstance>

archive

Returns Promise<void>

delete

Returns Promise<void>

restore

Returns Promise<FlowInstance>

ProtectedgetPath

Parameters

Returns string

enable

Returns Promise<FlowInstance>

disable

Returns Promise<FlowInstance>

updateToLatestFlow

Returns Promise<FlowInstance>

setup

Returns Promise<FlowInstance>

reset

Parameters

Returns Promise<FlowInstance>

openConfiguration

Parameters

Returns Promise<void>

openEditor

Parameters

Returns Promise<void>

embedEditor

Parameters

Returns Promise<void>

startRun

Parameters

Returns Promise<FlowRun>

run

Parameters

Returns Promise<FlowRun>

Properties

Protectedoptions

Protectedclient

Protectedselector

Settings

On This Page

`Protected`getPath

`Protected`options

`Protected`client

`Protected`selector