Class Workflow

Hierarchy (View Summary)

Workflow
- Workflow

Constructors

constructor

new Workflow(
transport: Transport,
options?: { context?: RequestContext; timeoutMs?: number },
): Workflow
Parameters
- transport: Transport
- Optionaloptions: { context?: RequestContext; timeoutMs?: number }
Returns Workflow

Methods

`Static`connect

connect(
    options?: {
        name?: string;
        context?: RequestContext;
        timeoutMs?: number;
    },
): Workflow
Parameters
- Optionaloptions: { name?: string; context?: RequestContext; timeoutMs?: number }
Returns Workflow

applyDefinition

applyDefinition(
    provider: string,
    idempotencyKey: string,
    spec?: {
        id?: string;
        target?: {
            steps?: {
                id?: string;
                inputs?: {
                    [key: string]: {
                        kind?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                    };
                };
                when?: {
                    value?: { kind?: ... };
                    equals?: string | number | boolean | object | (...)[] | null;
                };
                timeoutSeconds?: number;
                metadata?: object;
                action?: | { case: undefined; value?: undefined }
                | {
                    case: "app";
                    value: {
                        name?: (...) | (...);
                        operation?: (...) | (...);
                        input?: (...) | (...);
                        connection?: (...) | (...);
                        instance?: (...) | (...);
                        credentialMode?: (...) | (...);
                    };
                }
                | {
                    case: "agent";
                    value: {
                        provider?: (...)
                        | (...);
                        model?: (...) | (...);
                        sessionKey?: (...) | (...);
                        prompt?: (...) | (...);
                        messages?: (...) | (...);
                        tools?: (...) | (...);
                        output?: (...) | (...);
                        modelOptions?: (...) | (...);
                    };
                };
            }[];
        };
        activations?: {
            id?: string;
            input?: {
                kind?: | { case: undefined; value?: undefined }
                | {
                    case: "literal";
                    value: string | number | boolean | object | (...)[] | null;
                }
                | { case: "object"; value: { fields?: (...)
                | (...) } }
                | { case: "array"; value: { values?: (...) | (...) } }
                | { case: "template"; value: { template?: (...) | (...) } }
                | { case: "input"; value: { path?: (...) | (...) } }
                | { case: "signal"; value: { path?: (...) | (...) } }
                | {
                    case: "stepOutput";
                    value: { stepId?: (...) | (...); path?: (...) | (...) };
                }
                | {
                    case: "stepInput";
                    value: { stepId?: (...)
                    | (...); path?: (...) | (...) };
                };
            };
            paused?: boolean;
            trigger?: | { case: undefined; value?: undefined }
            | { case: "schedule"; value: { cron?: string; timezone?: string } }
            | {
                case: "event";
                value: {
                    match?: {
                        type?: (...) | (...);
                        source?: (...) | (...);
                        subject?: (...) | (...);
                    };
                };
            };
        }[];
        paused?: boolean;
        runAs?: string;
    },
): Promise<WorkflowDefinition>
Parameters
- provider: string
- idempotencyKey: string
- Optionalspec: {
      id?: string;
      target?: {
          steps?: {
              id?: string;
              inputs?: {
                  [key: string]: {
                      kind?:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                  };
              };
              when?: {
                  value?: { kind?: ... };
                  equals?: string | number | boolean | object | (...)[] | null;
              };
              timeoutSeconds?: number;
              metadata?: object;
              action?: | { case: undefined; value?: undefined }
              | {
                  case: "app";
                  value: {
                      name?: (...) | (...);
                      operation?: (...) | (...);
                      input?: (...) | (...);
                      connection?: (...) | (...);
                      instance?: (...) | (...);
                      credentialMode?: (...) | (...);
                  };
              }
              | {
                  case: "agent";
                  value: {
                      provider?: (...)
                      | (...);
                      model?: (...) | (...);
                      sessionKey?: (...) | (...);
                      prompt?: (...) | (...);
                      messages?: (...) | (...);
                      tools?: (...) | (...);
                      output?: (...) | (...);
                      modelOptions?: (...) | (...);
                  };
              };
          }[];
      };
      activations?: {
          id?: string;
          input?: {
              kind?: | { case: undefined; value?: undefined }
              | {
                  case: "literal";
                  value: string | number | boolean | object | (...)[] | null;
              }
              | { case: "object"; value: { fields?: (...)
              | (...) } }
              | { case: "array"; value: { values?: (...) | (...) } }
              | { case: "template"; value: { template?: (...) | (...) } }
              | { case: "input"; value: { path?: (...) | (...) } }
              | { case: "signal"; value: { path?: (...) | (...) } }
              | {
                  case: "stepOutput";
                  value: { stepId?: (...) | (...); path?: (...) | (...) };
              }
              | {
                  case: "stepInput";
                  value: { stepId?: (...)
                  | (...); path?: (...) | (...) };
              };
          };
          paused?: boolean;
          trigger?: | { case: undefined; value?: undefined }
          | { case: "schedule"; value: { cron?: string; timezone?: string } }
          | {
              case: "event";
              value: {
                  match?: {
                      type?: (...) | (...);
                      source?: (...) | (...);
                      subject?: (...) | (...);
                  };
              };
          };
      }[];
      paused?: boolean;
      runAs?: string;
  }
Returns Promise<WorkflowDefinition>

applyDefinitionRaw

applyDefinitionRaw(
    request: {
        provider?: string;
        spec?: {
            id?: string;
            target?: {
                steps?: {
                    id?: string;
                    inputs?: { [key: string]: { kind?: ... } };
                    when?: {
                        value?: (...) | (...);
                        equals?: (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...);
                    };
                    timeoutSeconds?: number;
                    metadata?: object;
                    action?: | { case: undefined; value?: undefined }
                    | {
                        case: "app";
                        value: {
                            name?: ...;
                            operation?: ...;
                            input?: ...;
                            connection?: ...;
                            instance?: ...;
                            credentialMode?: ...;
                        };
                    }
                    | {
                        case: "agent";
                        value: {
                            provider?: ...;
                            model?: ...;
                            sessionKey?: ...;
                            prompt?: ...;
                            messages?: ...;
                            tools?: ...;
                            output?: ...;
                            modelOptions?: ...;
                        };
                    };
                }[];
            };
            activations?: {
                id?: string;
                input?: {
                    kind?: | { case: undefined; value?: undefined }
                    | {
                        case: "literal";
                        value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                    }
                    | { case: "object"; value: { fields?: ... } }
                    | { case: "array"; value: { values?: ... } }
                    | { case: "template"; value: { template?: ... } }
                    | { case: "input"; value: { path?: ... } }
                    | { case: "signal"; value: { path?: ... } }
                    | { case: "stepOutput"; value: { stepId?: ...; path?: ... } }
                    | { case: "stepInput"; value: { stepId?: ...; path?: ... } };
                };
                paused?: boolean;
                trigger?: | { case: undefined; value?: undefined }
                | { case: "schedule"; value: { cron?: string; timezone?: string } }
                | {
                    case: "event";
                    value: { match?: { type?: ...; source?: ...; subject?: ... } };
                };
            }[];
            paused?: boolean;
            runAs?: string;
        };
        idempotencyKey?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
    },
): Promise<WorkflowDefinition>
Parameters
- request: {
      provider?: string;
      spec?: {
          id?: string;
          target?: {
              steps?: {
                  id?: string;
                  inputs?: { [key: string]: { kind?: ... } };
                  when?: {
                      value?: (...) | (...);
                      equals?: (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...);
                  };
                  timeoutSeconds?: number;
                  metadata?: object;
                  action?: | { case: undefined; value?: undefined }
                  | {
                      case: "app";
                      value: {
                          name?: ...;
                          operation?: ...;
                          input?: ...;
                          connection?: ...;
                          instance?: ...;
                          credentialMode?: ...;
                      };
                  }
                  | {
                      case: "agent";
                      value: {
                          provider?: ...;
                          model?: ...;
                          sessionKey?: ...;
                          prompt?: ...;
                          messages?: ...;
                          tools?: ...;
                          output?: ...;
                          modelOptions?: ...;
                      };
                  };
              }[];
          };
          activations?: {
              id?: string;
              input?: {
                  kind?: | { case: undefined; value?: undefined }
                  | {
                      case: "literal";
                      value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                  }
                  | { case: "object"; value: { fields?: ... } }
                  | { case: "array"; value: { values?: ... } }
                  | { case: "template"; value: { template?: ... } }
                  | { case: "input"; value: { path?: ... } }
                  | { case: "signal"; value: { path?: ... } }
                  | { case: "stepOutput"; value: { stepId?: ...; path?: ... } }
                  | { case: "stepInput"; value: { stepId?: ...; path?: ... } };
              };
              paused?: boolean;
              trigger?: | { case: undefined; value?: undefined }
              | { case: "schedule"; value: { cron?: string; timezone?: string } }
              | {
                  case: "event";
                  value: { match?: { type?: ...; source?: ...; subject?: ... } };
              };
          }[];
          paused?: boolean;
          runAs?: string;
      };
      idempotencyKey?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
  }
Returns Promise<WorkflowDefinition>

getDefinition

getDefinition(
provider: string,
definitionId: string,
): Promise<WorkflowDefinition>
Parameters
- provider: string
- definitionId: string
Returns Promise<WorkflowDefinition>

getDefinitionRaw

getDefinitionRaw(
    request: {
        definitionId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<WorkflowDefinition>
Parameters
- request: {
      definitionId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<WorkflowDefinition>

listDefinitions

listDefinitions(provider: string): Promise<WorkflowDefinition[]>
Parameters
- provider: string
Returns Promise<WorkflowDefinition[]>

listDefinitionsRaw

listDefinitionsRaw(
    request: {
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<ListWorkflowProviderDefinitionsResponse>
Parameters
- request: {
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<ListWorkflowProviderDefinitionsResponse>

setDefinitionPaused

setDefinitionPaused(
    provider: string,
    definitionId: string,
    paused: boolean,
): Promise<WorkflowDefinition>
Parameters
- provider: string
- definitionId: string
- paused: boolean
Returns Promise<WorkflowDefinition>

setDefinitionPausedRaw

setDefinitionPausedRaw(
    request: {
        definitionId?: string;
        paused?: boolean;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<WorkflowDefinition>
Parameters
- request: {
      definitionId?: string;
      paused?: boolean;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<WorkflowDefinition>

setActivationPaused

setActivationPaused(
    provider: string,
    definitionId: string,
    activationId: string,
    paused: boolean,
): Promise<WorkflowDefinition>
Parameters
- provider: string
- definitionId: string
- activationId: string
- paused: boolean
Returns Promise<WorkflowDefinition>

setActivationPausedRaw

setActivationPausedRaw(
    request: {
        definitionId?: string;
        activationId?: string;
        paused?: boolean;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<WorkflowDefinition>
Parameters
- request: {
      definitionId?: string;
      activationId?: string;
      paused?: boolean;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<WorkflowDefinition>

deleteDefinition

deleteDefinition(provider: string, definitionId: string): Promise<void>
Parameters
- provider: string
- definitionId: string
Returns Promise<void>

deleteDefinitionRaw

deleteDefinitionRaw(
    request: {
        definitionId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<void>
Parameters
- request: {
      definitionId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<void>

startRun

startRun(
    idempotencyKey: string,
    workflowKey: string,
    provider: string,
    definitionId: string,
    expectedDefinitionGeneration: bigint,
    input?: object,
): Promise<WorkflowRun>
Parameters
- idempotencyKey: string
- workflowKey: string
- provider: string
- definitionId: string
- expectedDefinitionGeneration: bigint
- Optionalinput: object
Returns Promise<WorkflowRun>

startRunRaw

startRunRaw(
    request: {
        idempotencyKey?: string;
        workflowKey?: string;
        provider?: string;
        definitionId?: string;
        input?: object;
        expectedDefinitionGeneration?: bigint;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
    },
): Promise<WorkflowRun>
Parameters
- request: {
      idempotencyKey?: string;
      workflowKey?: string;
      provider?: string;
      definitionId?: string;
      input?: object;
      expectedDefinitionGeneration?: bigint;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
  }
Returns Promise<WorkflowRun>

listRuns

listRuns(
    provider: string,
    pageSize: number,
    pageToken: string,
    status: number,
    targetApp: string,
): Promise<ListWorkflowProviderRunsResponse>
Parameters
- provider: string
- pageSize: number
- pageToken: string
- status: number
- targetApp: string
Returns Promise<ListWorkflowProviderRunsResponse>

listRunsRaw

listRunsRaw(
    request: {
        pageSize?: number;
        pageToken?: string;
        status?: number;
        targetApp?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<ListWorkflowProviderRunsResponse>
Parameters
- request: {
      pageSize?: number;
      pageToken?: string;
      status?: number;
      targetApp?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<ListWorkflowProviderRunsResponse>

getRun

getRun(provider: string, runId: string): Promise<WorkflowRun>
Parameters
- provider: string
- runId: string
Returns Promise<WorkflowRun>

getRunRaw

getRunRaw(
    request: {
        runId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<WorkflowRun>
Parameters
- request: {
      runId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<WorkflowRun>

getRunEvents

getRunEvents(provider: string, runId: string): Promise<WorkflowRunEvent[]>
Parameters
- provider: string
- runId: string
Returns Promise<WorkflowRunEvent[]>

getRunEventsRaw

getRunEventsRaw(
    request: {
        runId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<GetWorkflowProviderRunEventsResponse>
Parameters
- request: {
      runId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<GetWorkflowProviderRunEventsResponse>

getRunOutput

getRunOutput(provider: string, runId: string): Promise<JsonInput | undefined>
Parameters
- provider: string
- runId: string
Returns Promise<JsonInput | undefined>

getRunOutputRaw

getRunOutputRaw(
    request: {
        runId?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<GetWorkflowProviderRunOutputResponse>
Parameters
- request: {
      runId?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<GetWorkflowProviderRunOutputResponse>

cancelRun

cancelRun(provider: string, runId: string, reason: string): Promise<WorkflowRun>
Parameters
- provider: string
- runId: string
- reason: string
Returns Promise<WorkflowRun>

cancelRunRaw

cancelRunRaw(
    request: {
        runId?: string;
        reason?: string;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<WorkflowRun>
Parameters
- request: {
      runId?: string;
      reason?: string;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<WorkflowRun>

signalRun

signalRun(
    provider: string,
    runId: string,
    signal?: {
        id?: string;
        name?: string;
        payload?: object;
        metadata?: object;
        createdAt?: Date;
        idempotencyKey?: string;
        sequence?: bigint;
    },
): Promise<SignalWorkflowRunResponse>
Parameters
- provider: string
- runId: string
- Optionalsignal: {
      id?: string;
      name?: string;
      payload?: object;
      metadata?: object;
      createdAt?: Date;
      idempotencyKey?: string;
      sequence?: bigint;
  }
Returns Promise<SignalWorkflowRunResponse>

signalRunRaw

signalRunRaw(
    request: {
        runId?: string;
        signal?: {
            id?: string;
            name?: string;
            payload?: object;
            metadata?: object;
            createdAt?: Date;
            idempotencyKey?: string;
            sequence?: bigint;
        };
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
        provider?: string;
    },
): Promise<SignalWorkflowRunResponse>
Parameters
- request: {
      runId?: string;
      signal?: {
          id?: string;
          name?: string;
          payload?: object;
          metadata?: object;
          createdAt?: Date;
          idempotencyKey?: string;
          sequence?: bigint;
      };
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
      provider?: string;
  }
Returns Promise<SignalWorkflowRunResponse>

signalOrStartRun

signalOrStartRun(
    workflowKey: string,
    idempotencyKey: string,
    provider: string,
    definitionId: string,
    expectedDefinitionGeneration: bigint,
    signal?: {
        id?: string;
        name?: string;
        payload?: object;
        metadata?: object;
        createdAt?: Date;
        idempotencyKey?: string;
        sequence?: bigint;
    },
    input?: object,
): Promise<SignalWorkflowRunResponse>
Parameters
- workflowKey: string
- idempotencyKey: string
- provider: string
- definitionId: string
- expectedDefinitionGeneration: bigint
- Optionalsignal: {
      id?: string;
      name?: string;
      payload?: object;
      metadata?: object;
      createdAt?: Date;
      idempotencyKey?: string;
      sequence?: bigint;
  }
- Optionalinput: object
Returns Promise<SignalWorkflowRunResponse>

signalOrStartRunRaw

signalOrStartRunRaw(
    request: {
        workflowKey?: string;
        idempotencyKey?: string;
        signal?: {
            id?: string;
            name?: string;
            payload?: object;
            metadata?: object;
            createdAt?: Date;
            idempotencyKey?: string;
            sequence?: bigint;
        };
        provider?: string;
        definitionId?: string;
        input?: object;
        expectedDefinitionGeneration?: bigint;
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
    },
): Promise<SignalWorkflowRunResponse>
Parameters
- request: {
      workflowKey?: string;
      idempotencyKey?: string;
      signal?: {
          id?: string;
          name?: string;
          payload?: object;
          metadata?: object;
          createdAt?: Date;
          idempotencyKey?: string;
          sequence?: bigint;
      };
      provider?: string;
      definitionId?: string;
      input?: object;
      expectedDefinitionGeneration?: bigint;
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
  }
Returns Promise<SignalWorkflowRunResponse>

deliverEvent

deliverEvent(
    provider: string,
    event?: {
        id?: string;
        source?: string;
        specVersion?: string;
        type?: string;
        subject?: string;
        time?: Date;
        datacontenttype?: string;
        data?: object;
        extensions?: {
            [key: string]: string | number | boolean | object | unknown[] | null;
        };
    },
): Promise<WorkflowEvent>
Parameters
- provider: string
- Optionalevent: {
      id?: string;
      source?: string;
      specVersion?: string;
      type?: string;
      subject?: string;
      time?: Date;
      datacontenttype?: string;
      data?: object;
      extensions?: {
          [key: string]: string | number | boolean | object | unknown[] | null;
      };
  }
Returns Promise<WorkflowEvent>

deliverEventRaw

deliverEventRaw(
    request: {
        provider?: string;
        event?: {
            id?: string;
            source?: string;
            specVersion?: string;
            type?: string;
            subject?: string;
            time?: Date;
            datacontenttype?: string;
            data?: object;
            extensions?: {
                [key: string]: string | number | boolean | object | unknown[] | null;
            };
        };
        context?: {
            subject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            credential?: {
                mode?: string;
                subjectId?: string;
                connection?: string;
                instance?: string;
            };
            access?: { policy?: string; role?: string };
            workflow?: object;
            host?: { publicBaseUrl?: string };
            agentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            caller?: { kind?: string; name?: string };
            invocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            };
            toolRefs?: {
                app?: string;
                operation?: string;
                connection?: string;
                instance?: string;
                title?: string;
                description?: string;
                credentialMode?: string;
                system?: string;
                runAs?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                };
            }[];
            toolRefsSet?: boolean;
            requestMeta?: {
                clientIp?: string;
                remoteAddr?: string;
                userAgent?: string;
            };
            agent?: { providerName?: string; sessionId?: string; turnId?: string };
        };
    },
): Promise<WorkflowEvent>
Parameters
- request: {
      provider?: string;
      event?: {
          id?: string;
          source?: string;
          specVersion?: string;
          type?: string;
          subject?: string;
          time?: Date;
          datacontenttype?: string;
          data?: object;
          extensions?: {
              [key: string]: string | number | boolean | object | unknown[] | null;
          };
      };
      context?: {
          subject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          credential?: {
              mode?: string;
              subjectId?: string;
              connection?: string;
              instance?: string;
          };
          access?: { policy?: string; role?: string };
          workflow?: object;
          host?: { publicBaseUrl?: string };
          agentSubject?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          };
          caller?: { kind?: string; name?: string };
          invocation?: {
              requestId?: string;
              depth?: number;
              callChain?: string[];
              surface?: string;
              internalConnectionAccess?: boolean;
              connection?: string;
          };
          toolRefs?: {
              app?: string;
              operation?: string;
              connection?: string;
              instance?: string;
              title?: string;
              description?: string;
              credentialMode?: string;
              system?: string;
              runAs?: {
                  id?: string;
                  email?: string;
                  displayName?: string;
                  scopes?: string[];
                  permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
              };
          }[];
          toolRefsSet?: boolean;
          requestMeta?: {
              clientIp?: string;
              remoteAddr?: string;
              userAgent?: string;
          };
          agent?: { providerName?: string; sessionId?: string; turnId?: string };
      };
  }
Returns Promise<WorkflowEvent>

Class Workflow

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Workflow

Methods

Staticconnect

Parameters

Returns Workflow

applyDefinition

Parameters

Returns Promise<WorkflowDefinition>

applyDefinitionRaw

Parameters

Returns Promise<WorkflowDefinition>

getDefinition

Parameters

Returns Promise<WorkflowDefinition>

getDefinitionRaw

Parameters

Returns Promise<WorkflowDefinition>

listDefinitions

Parameters

Returns Promise<WorkflowDefinition[]>

listDefinitionsRaw

Parameters

Returns Promise<ListWorkflowProviderDefinitionsResponse>

setDefinitionPaused

Parameters

Returns Promise<WorkflowDefinition>

setDefinitionPausedRaw

Parameters

Returns Promise<WorkflowDefinition>

setActivationPaused

Parameters

Returns Promise<WorkflowDefinition>

setActivationPausedRaw

Parameters

Returns Promise<WorkflowDefinition>

deleteDefinition

Parameters

Returns Promise<void>

deleteDefinitionRaw

Parameters

Returns Promise<void>

startRun

Parameters

Returns Promise<WorkflowRun>

startRunRaw

Parameters

Returns Promise<WorkflowRun>

listRuns

Parameters

Returns Promise<ListWorkflowProviderRunsResponse>

listRunsRaw

Parameters

Returns Promise<ListWorkflowProviderRunsResponse>

getRun

Parameters

Returns Promise<WorkflowRun>

getRunRaw

Parameters

Returns Promise<WorkflowRun>

getRunEvents

Parameters

Returns Promise<WorkflowRunEvent[]>

getRunEventsRaw

Parameters

Returns Promise<GetWorkflowProviderRunEventsResponse>

getRunOutput

Parameters

Returns Promise<JsonInput | undefined>

getRunOutputRaw

Parameters

Returns Promise<GetWorkflowProviderRunOutputResponse>

cancelRun

`Static`connect