Class FlowInstanceAccessor

Hierarchy (View Summary)

Constructors

constructor

Methods

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

Properties

options client selector

Constructors

constructor

Methods

getUniqueIdentifier

get

getId

  • getId(): Promise<string>

    Returns Promise<string>

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>

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>

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>

archive

  • archive(): Promise<void>

    Returns Promise<void>

delete

  • delete(): Promise<void>

    Returns Promise<void>

ProtectedgetPath

  • getPath(operation?: string): string

    Parameters

    • Optionaloperation: string

    Returns string

enable

  • enable(): Promise<FlowInstance>

    Returns Promise<FlowInstance>

disable

  • disable(): Promise<FlowInstance>

    Returns Promise<FlowInstance>

updateToLatestFlow

  • updateToLatestFlow(): Promise<FlowInstance>

    Returns Promise<FlowInstance>

setup

  • setup(): Promise<FlowInstance>

    Returns Promise<FlowInstance>

reset

openConfiguration

openEditor

startRun

run

Properties

Protectedoptions

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

Protectedclient

client: IntegrationAppApiClient

Protectedselector

selector: string | FlowInstanceSelector

Settings

Member Visibility

On This Page

Constructors
Methods
Properties