Class ConnectionLevelFlowAccessor

Hierarchy

ConnectionLevelElementAccessor<FlowInstance, UpdateFlowInstanceRequest>
- ConnectionLevelFlowAccessor

Index

Constructors

constructor

new ConnectionLevelFlowAccessor(client, connectionSelector, flowSelector, query): ConnectionLevelFlowAccessor
Parameters
- client: IntegrationAppApiClient
- connectionSelector: string
- flowSelector: string
- query: InstanceKeyQuery
Returns ConnectionLevelFlowAccessor
Overrides ConnectionLevelElementAccessor< FlowInstance, UpdateFlowInstanceRequest >.constructor
- Defined in flows/accessors.ts:280

Properties

client

client: IntegrationAppApiClient

connectionSelector

connectionSelector: string

flowSelector

flowSelector: string

query

query: InstanceKeyQuery

`Protected`endpoint

endpoint: string

`Protected`selector

selector: string

`Protected`elementKey

elementKey: string

Methods

enable

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

disable

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

run

run(options): Promise<FlowRun>
Parameters
- options: {
  nodeKey?: string;
  input?: any;
  }
  - OptionalnodeKey?: string
  - Optionalinput?: any
Returns Promise<FlowRun>
- Defined in flows/accessors.ts:297

openConfiguration

openConfiguration(options?): Promise<void>
Parameters
- Optionaloptions: OpenFlowInstanceConfigurationOptions
Returns Promise<void>
- Defined in flows/accessors.ts:301

openEditor

openEditor(options?): Promise<void>
Parameters
- Optionaloptions: OpenFlowInstanceEditorOptions
Returns Promise<void>
- Defined in flows/accessors.ts:315

`Protected`uri

uri(path?, query?): string
Parameters
- path: string = ''
- query: {} = {}
Returns string
Inherited from ConnectionLevelElementAccessor.uri
- Defined in integration-elements/connection-level-element.accessor.ts:19

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ConnectionLevelElementAccessor.getUniqueIdentifier
- Defined in integration-elements/connection-level-element.accessor.ts:25

get

get(query?): Promise<FlowInstance>
Parameters
- query: {
  autoCreate?: boolean;
  } = {}
  - OptionalautoCreate?: boolean
Returns Promise<FlowInstance>
Inherited from ConnectionLevelElementAccessor.get
- Defined in integration-elements/connection-level-element.accessor.ts:29

create

create(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ConnectionLevelElementAccessor.create
- Defined in integration-elements/connection-level-element.accessor.ts:33

patch

patch(data): Promise<FlowInstance>
Parameters
- data: Partial<{
      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 ConnectionLevelElementAccessor.patch
- Defined in integration-elements/connection-level-element.accessor.ts:37

put

put(data): 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;
      };
  }
  - Optionalname?: string
  - Optionalenabled?: boolean
  - Optionalparameters?: any
  - Optionalnodes?: Record<string, {
        name?: string;
        type?: string;
        userConfig?: any;
        config?: any;
        onError?: "stop" | "continue";
        links?: {
            key?: string;
            filter?: any;
            name?: string;
        }[];
        concurrency?: number;
        isCustomized?: boolean;
    }>
  - OptionalarchivedAt?: string
  - Optionalcustomized?: {
    name?: boolean;
    nodes?: boolean;
    }
    - Optionalname?: boolean
    - Optionalnodes?: boolean
Returns Promise<FlowInstance>
Inherited from ConnectionLevelElementAccessor.put
- Defined in integration-elements/connection-level-element.accessor.ts:41

reset

reset(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ConnectionLevelElementAccessor.reset
- Defined in integration-elements/connection-level-element.accessor.ts:49

setup

setup(): Promise<FlowInstance>
Returns Promise<FlowInstance>
Inherited from ConnectionLevelElementAccessor.setup
- Defined in integration-elements/connection-level-element.accessor.ts:53

Class ConnectionLevelFlowAccessor

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConnectionLevelFlowAccessor

Properties

client

connectionSelector

flowSelector

query

Protectedendpoint

Protectedselector

ProtectedelementKey

Methods

enable

Returns Promise<FlowInstance>

disable

Returns Promise<FlowInstance>

run

Parameters

OptionalnodeKey?: string

Optionalinput?: any

Returns Promise<FlowRun>

openConfiguration

Parameters

Returns Promise<void>

openEditor

Parameters

Returns Promise<void>

Protecteduri

Parameters

Returns string

getUniqueIdentifier

Returns string

get

Parameters

OptionalautoCreate?: boolean

Returns Promise<FlowInstance>

create

Returns Promise<FlowInstance>

patch

Parameters

Returns Promise<FlowInstance>

put

Parameters

Optionalname?: string

Optionalenabled?: boolean

Optionalparameters?: any

Optionalnodes?: Record<string, { name?: string; type?: string; userConfig?: any; config?: any; onError?: "stop" | "continue"; links?: { key?: string; filter?: any; name?: string; }[]; concurrency?: number; isCustomized?: boolean; }>

OptionalarchivedAt?: string

Optionalcustomized?: { name?: boolean; nodes?: boolean; }

Optionalname?: boolean

Optionalnodes?: boolean

Returns Promise<FlowInstance>

archive

Returns Promise<void>

reset

Returns Promise<FlowInstance>

setup

Returns Promise<FlowInstance>

Settings

On This Page

`Protected`endpoint

`Protected`selector

`Protected`elementKey

`Optional`nodeKey?: string

`Optional`input?: any

`Protected`uri

`Optional`autoCreate?: boolean

`Optional`name?: string

`Optional`enabled?: boolean

`Optional`parameters?: any

`Optional`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;
}>

`Optional`archivedAt?: string

`Optional`customized?: {
name?: boolean;
nodes?: boolean;
}

`Optional`name?: boolean

`Optional`nodes?: boolean