Class FlowInstanceAccessor

Hierarchy (View Summary)

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

Index

Constructors

Properties

Methods

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

Constructors

constructor

new FlowInstanceAccessor(
client: IntegrationAppApiClient,
selector: string | FlowInstanceSelector,
): FlowInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | FlowInstanceSelector
Returns FlowInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in flows/accessors.ts:85

Properties

`Protected`options

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

`Protected`client

client: IntegrationAppApiClient

`Protected`selector

selector: string | FlowInstanceSelector

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in accessors.ts:151

get

get(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.get
- Defined in accessors.ts:155

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in accessors.ts:159

create

create(
    data?: {
        name?: string;
        userId?: string;
        flowId?: string;
        connectionId?: string;
        integrationId?: string;
        instanceKey?: string;
        parameters?: any;
        nodes?: Record<
            string,
            {
                name?: string;
                type?: string;
                userConfig?: any;
                config?: any;
                onError?: "stop"
                | "continue";
                concurrency?: number;
                ui?: any;
                links?: { key?: string; filter?: any; name?: string }[];
                isCustomized?: boolean;
            },
        >;
        enabled?: boolean;
        customized?: { name?: boolean; nodes?: boolean };
    },
): Promise<FlowInstance>
Parameters
- Optionaldata: {
      name?: string;
      userId?: string;
      flowId?: string;
      connectionId?: string;
      integrationId?: string;
      instanceKey?: string;
      parameters?: any;
      nodes?: Record<
          string,
          {
              name?: string;
              type?: string;
              userConfig?: any;
              config?: any;
              onError?: "stop"
              | "continue";
              concurrency?: number;
              ui?: any;
              links?: { key?: string; filter?: any; name?: string }[];
              isCustomized?: boolean;
          },
      >;
      enabled?: boolean;
      customized?: { name?: boolean; nodes?: boolean };
  }
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.create
- Defined in accessors.ts:174

put

put(
    data: {
        name?: string;
        userId?: string;
        flowId?: string;
        connectionId?: string;
        integrationId?: string;
        instanceKey?: string;
        parameters?: any;
        nodes?: Record<
            string,
            {
                name?: string;
                type?: string;
                userConfig?: any;
                config?: any;
                onError?: "stop"
                | "continue";
                concurrency?: number;
                ui?: any;
                links?: { key?: string; filter?: any; name?: string }[];
                isCustomized?: boolean;
            },
        >;
        enabled?: boolean;
        customized?: { name?: boolean; nodes?: boolean };
    },
): Promise<FlowInstance>
Parameters
- data: {
      name?: string;
      userId?: string;
      flowId?: string;
      connectionId?: string;
      integrationId?: string;
      instanceKey?: string;
      parameters?: any;
      nodes?: Record<
          string,
          {
              name?: string;
              type?: string;
              userConfig?: any;
              config?: any;
              onError?: "stop"
              | "continue";
              concurrency?: number;
              ui?: any;
              links?: { key?: string; filter?: any; name?: string }[];
              isCustomized?: boolean;
          },
      >;
      enabled?: boolean;
      customized?: { name?: boolean; nodes?: boolean };
  }
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.put
- Defined in accessors.ts:193

patch

patch(
    data: {
        name?: string;
        enabled?: boolean;
        parameters?: any;
        nodes?: Record<
            string,
            {
                name?: string;
                type?: string;
                userConfig?: any;
                config?: any;
                onError?: "stop"
                | "continue";
                links?: { key?: string; filter?: any; name?: string }[];
                concurrency?: number;
                isCustomized?: boolean;
            },
        >;
        archivedAt?: string;
        customized?: { name?: boolean; nodes?: boolean };
    },
): Promise<FlowInstance>
Parameters
- data: {
      name?: string;
      enabled?: boolean;
      parameters?: any;
      nodes?: Record<
          string,
          {
              name?: string;
              type?: string;
              userConfig?: any;
              config?: any;
              onError?: "stop"
              | "continue";
              links?: { key?: string; filter?: any; name?: string }[];
              concurrency?: number;
              isCustomized?: boolean;
          },
      >;
      archivedAt?: string;
      customized?: { name?: boolean; nodes?: boolean };
  }
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors.ts:203

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
- use archive instead
Inherited from ElementInstanceAccessor.delete
- Defined in accessors.ts:220

restore

restore(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.restore
- Defined in accessors.ts:224

`Protected`getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in accessors.ts:228

enable

enable(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in flows/accessors.ts:97

disable

disable(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in flows/accessors.ts:101

updateToLatestFlow

updateToLatestFlow(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in flows/accessors.ts:105

setup

setup(): Promise<FlowInstance>
Returns Promise<FlowInstance>
- Defined in flows/accessors.ts:110

reset

reset(options?: ResetFlowInstanceOptions): Promise<FlowInstance>
Parameters
- Optionaloptions: ResetFlowInstanceOptions
Returns Promise<FlowInstance>
- Defined in flows/accessors.ts:115

openConfiguration

openConfiguration(
__namedParameters?: OpenFlowInstanceConfigurationOptions,
): Promise<void>
Parameters
- __namedParameters: OpenFlowInstanceConfigurationOptions = {}
Returns Promise<void>
- Defined in flows/accessors.ts:120

openEditor

openEditor(__namedParameters?: OpenFlowInstanceEditorOptions): Promise<void>
Parameters
- __namedParameters: OpenFlowInstanceEditorOptions = {}
Returns Promise<void>
- Defined in flows/accessors.ts:131

embedEditor

embedEditor(
__namedParameters?: { mountTargetSelector?: string } & OpenFlowInstanceEditorOptions,
): Promise<void>
Parameters
- __namedParameters: { mountTargetSelector?: string } & OpenFlowInstanceEditorOptions = {}
Returns Promise<void>
- Defined in flows/accessors.ts:140

startRun

startRun(options?: RunFlowOptions): Promise<FlowRun>
Parameters
- options: RunFlowOptions = {}
Returns Promise<FlowRun>
- Defined in flows/accessors.ts:156

run

run(options?: RunFlowOptions): Promise<FlowRun>
Parameters
- options: RunFlowOptions = {}
Returns Promise<FlowRun>
- Defined in flows/accessors.ts:170

Class FlowInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowInstanceAccessor

Properties

Protectedoptions

Protectedclient

Protectedselector

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>

Deprecated

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>

Settings

On This Page

`Protected`options

`Protected`client

`Protected`selector

`Protected`getPath