Class FlowInstanceAccessor

Hierarchy (view full)

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

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

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:154

get

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

getId

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

create

create(data?): 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;
      };
  }
  - Optionalname?: string
  - OptionaluserId?: string
  - OptionalflowId?: string
  - OptionalconnectionId?: string
  - OptionalintegrationId?: string
  - OptionalinstanceKey?: string
  - Optionalparameters?: any
  - Optionalnodes?: 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;
    }>
  - Optionalenabled?: boolean
  - Optionalcustomized?: {
    name?: boolean;
    nodes?: boolean;
    }
    - Optionalname?: boolean
    - Optionalnodes?: boolean
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.create
- Defined in accessors.ts:181

put

put(data): 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;
      };
  }
  - Optionalname?: string
  - OptionaluserId?: string
  - OptionalflowId?: string
  - OptionalconnectionId?: string
  - OptionalintegrationId?: string
  - OptionalinstanceKey?: string
  - Optionalparameters?: any
  - Optionalnodes?: 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;
    }>
  - Optionalenabled?: boolean
  - Optionalcustomized?: {
    name?: boolean;
    nodes?: boolean;
    }
    - Optionalname?: boolean
    - Optionalnodes?: boolean
Returns Promise<FlowInstance>
Inherited from ElementInstanceAccessor.put
- Defined in accessors.ts:200

patch

patch(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 ElementInstanceAccessor.patch
- Defined in accessors.ts:210

delete

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

`Protected`getPath

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

enable

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

disable

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

updateToLatestFlow

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

setup

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

reset

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

openConfiguration

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

openEditor

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

startRun

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

run

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

Class FlowInstanceAccessor

Hierarchy (view full)

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

Optionalname?: string

OptionaluserId?: string

OptionalflowId?: string

OptionalconnectionId?: string

OptionalintegrationId?: string

OptionalinstanceKey?: string

Optionalparameters?: any

Optionalnodes?: 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; }>

Optionalenabled?: boolean

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

Optionalname?: boolean

Optionalnodes?: boolean

Returns Promise<FlowInstance>

put

Parameters

Optionalname?: string

OptionaluserId?: string

OptionalflowId?: string

OptionalconnectionId?: string

OptionalintegrationId?: string

OptionalinstanceKey?: string

Optionalparameters?: any

Optionalnodes?: 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; }>

Optionalenabled?: boolean

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

Optionalname?: boolean

Optionalnodes?: boolean

Returns Promise<FlowInstance>

patch

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>

delete

Returns Promise<void>

Deprecated

ProtectedgetPath

Parameters

Returns string

enable

Returns Promise<FlowInstance>

disable

Returns Promise<FlowInstance>

updateToLatestFlow

Returns Promise<FlowInstance>

setup

Returns Promise<FlowInstance>

reset

Parameters

`Protected`options

`Protected`client

`Protected`selector

`Optional`name?: string

`Optional`userId?: string

`Optional`flowId?: string

`Optional`connectionId?: string

`Optional`integrationId?: string

`Optional`instanceKey?: string

`Optional`parameters?: any

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

`Optional`enabled?: boolean

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

`Optional`name?: boolean

`Optional`nodes?: boolean

`Optional`name?: string

`Optional`userId?: string

`Optional`flowId?: string

`Optional`connectionId?: string

`Optional`integrationId?: string

`Optional`instanceKey?: string

`Optional`parameters?: any

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

`Optional`enabled?: boolean

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

`Optional`name?: boolean

`Optional`nodes?: 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

`Protected`getPath