Globus SDK for JavaScript
    Preparing search index...

    Variable deployConst

    deploy: (
        options?: {
            payload: {
                definition: {
                    Comment?: string;
                    StartAt: string;
                    States: {
                        [key: string]:
                            | {
                                Comment?: unknown;
                                End?: unknown;
                                InputPath?: unknown;
                                Next?: unknown;
                                Parameters?: unknown;
                                ResultPath?: unknown;
                                Type?: (...)
                                | (...);
                            } & { End?: (...)
                            | (...)
                            | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                InputPath?: (...) | (...);
                            } & { ResultPath?: (...)
                            | (...) }
                            | {
                                ActionScope?: (...) | (...);
                                ActionUrl: string;
                                Catch?: unknown;
                                Comment?: unknown;
                                End?: unknown;
                                ExceptionOnActionFailure: boolean;
                                InputPath?: unknown;
                                Next?: unknown;
                                Parameters?: unknown;
                                ResultPath?: unknown;
                                RunAs?: (...) | (...);
                                Type: string;
                                WaitTime?: (...) | (...);
                            } & { End?: (...)
                            | (...)
                            | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                InputPath?: (...) | (...);
                            } & { ResultPath?: (...)
                            | (...) } & { Catch?: (...) | (...) }
                            | {
                                Comment?: unknown;
                                Next?: string;
                                Seconds?: number;
                                SecondsPath?: string;
                                Timestamp?: string;
                                TimestampPath?: string;
                                Type?: string;
                            }
                            | {
                                Choices: ((...) & (...))[];
                                Comment?: string;
                                Default?: string;
                                Type?: string;
                            }
                            | {
                                Comment?: unknown;
                                Next: string;
                                Parameters: unknown;
                                ResultPath: unknown;
                                Type?: (...)
                                | (...);
                            } & { Parameters?: (...)
                            | (...) } & { ResultPath?: (...) | (...) }
                            | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                    };
                };
                description?: string;
                flow_administrators?: string[];
                flow_starters?: string[];
                flow_viewers?: string[];
                input_schema?: Record<string, unknown>;
                keywords?: string[];
                run_managers?: string[];
                run_monitors?: string[];
                subscription_id?: string;
                subtitle?: string;
                title?: string;
            };
            query?: undefined;
        } & BaseServiceMethodOptions,
        sdkOptions?: SDKOptions,
    ) => Promise<
        JSONFetchResponse<
            {
                api_version?: "1.0";
                created_at?: string;
                definition?: {
                    Comment?: string;
                    StartAt: string;
                    States: {
                        [key: string]: | {
                            Comment?: unknown;
                            End?: unknown;
                            InputPath?: unknown;
                            Next?: unknown;
                            Parameters?: unknown;
                            ResultPath?: unknown;
                            Type?: (...)
                            | (...);
                        } & { End?: (...)
                        | (...)
                        | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                            InputPath?: (...) | (...);
                        } & { ResultPath?: (...)
                        | (...) }
                        | {
                            ActionScope?: (...) | (...);
                            ActionUrl: string;
                            Catch?: unknown;
                            Comment?: unknown;
                            End?: unknown;
                            ExceptionOnActionFailure: boolean;
                            InputPath?: unknown;
                            Next?: unknown;
                            Parameters?: unknown;
                            ResultPath?: unknown;
                            RunAs?: (...) | (...);
                            Type: string;
                            WaitTime?: (...) | (...);
                        } & { End?: (...)
                        | (...)
                        | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                            InputPath?: (...) | (...);
                        } & { ResultPath?: (...)
                        | (...) } & { Catch?: (...) | (...) }
                        | {
                            Comment?: unknown;
                            Next?: string;
                            Seconds?: number;
                            SecondsPath?: string;
                            Timestamp?: string;
                            TimestampPath?: string;
                            Type?: string;
                        }
                        | {
                            Choices: ((...) & (...))[];
                            Comment?: string;
                            Default?: string;
                            Type?: string;
                        }
                        | {
                            Comment?: unknown;
                            Next: string;
                            Parameters: unknown;
                            ResultPath: unknown;
                            Type?: (...)
                            | (...);
                        } & { Parameters?: (...)
                        | (...) } & { ResultPath?: (...) | (...) }
                        | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                    };
                };
                description?: string;
                flow_administrators?: string[];
                flow_owner?: string;
                flow_starters?: string[];
                flow_url?: string;
                flow_viewers?: string[];
                globus_auth_scope?: string;
                globus_auth_scopes_by_RunAs?: string[];
                globus_auth_username?: string;
                id?: string;
                input_schema?: Record<string, unknown>;
                keywords?: string[];
                log_supported?: boolean;
                principal_urn?: string;
                subscription_id?: string;
                subtitle?: string;
                synchronous?: boolean;
                title?: string;
                types?: ("Action" | "Event")[];
                updated_at?: string;
                user_role?:
                    | "flow_owner"
                    | "flow_viewer"
                    | "flow_starter"
                    | "flow_administrator";
            },
        >,
    > = create

    An alias for create to match the API documentation.

    Type declaration

      • (
            options?: {
                payload: {
                    definition: {
                        Comment?: string;
                        StartAt: string;
                        States: {
                            [key: string]:
                                | {
                                    Comment?: unknown;
                                    End?: unknown;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) }
                                | {
                                    ActionScope?: (...) | (...);
                                    ActionUrl: string;
                                    Catch?: unknown;
                                    Comment?: unknown;
                                    End?: unknown;
                                    ExceptionOnActionFailure: boolean;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    RunAs?: (...) | (...);
                                    Type: string;
                                    WaitTime?: (...) | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) } & { Catch?: (...) | (...) }
                                | {
                                    Comment?: unknown;
                                    Next?: string;
                                    Seconds?: number;
                                    SecondsPath?: string;
                                    Timestamp?: string;
                                    TimestampPath?: string;
                                    Type?: string;
                                }
                                | {
                                    Choices: ((...) & (...))[];
                                    Comment?: string;
                                    Default?: string;
                                    Type?: string;
                                }
                                | {
                                    Comment?: unknown;
                                    Next: string;
                                    Parameters: unknown;
                                    ResultPath: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { Parameters?: (...)
                                | (...) } & { ResultPath?: (...) | (...) }
                                | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                        };
                    };
                    description?: string;
                    flow_administrators?: string[];
                    flow_starters?: string[];
                    flow_viewers?: string[];
                    input_schema?: Record<string, unknown>;
                    keywords?: string[];
                    run_managers?: string[];
                    run_monitors?: string[];
                    subscription_id?: string;
                    subtitle?: string;
                    title?: string;
                };
                query?: undefined;
            } & BaseServiceMethodOptions,
            sdkOptions?: SDKOptions,
        ): Promise<
            JSONFetchResponse<
                {
                    api_version?: "1.0";
                    created_at?: string;
                    definition?: {
                        Comment?: string;
                        StartAt: string;
                        States: {
                            [key: string]: | {
                                Comment?: unknown;
                                End?: unknown;
                                InputPath?: unknown;
                                Next?: unknown;
                                Parameters?: unknown;
                                ResultPath?: unknown;
                                Type?: (...)
                                | (...);
                            } & { End?: (...)
                            | (...)
                            | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                InputPath?: (...) | (...);
                            } & { ResultPath?: (...)
                            | (...) }
                            | {
                                ActionScope?: (...) | (...);
                                ActionUrl: string;
                                Catch?: unknown;
                                Comment?: unknown;
                                End?: unknown;
                                ExceptionOnActionFailure: boolean;
                                InputPath?: unknown;
                                Next?: unknown;
                                Parameters?: unknown;
                                ResultPath?: unknown;
                                RunAs?: (...) | (...);
                                Type: string;
                                WaitTime?: (...) | (...);
                            } & { End?: (...)
                            | (...)
                            | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                InputPath?: (...) | (...);
                            } & { ResultPath?: (...)
                            | (...) } & { Catch?: (...) | (...) }
                            | {
                                Comment?: unknown;
                                Next?: string;
                                Seconds?: number;
                                SecondsPath?: string;
                                Timestamp?: string;
                                TimestampPath?: string;
                                Type?: string;
                            }
                            | {
                                Choices: ((...) & (...))[];
                                Comment?: string;
                                Default?: string;
                                Type?: string;
                            }
                            | {
                                Comment?: unknown;
                                Next: string;
                                Parameters: unknown;
                                ResultPath: unknown;
                                Type?: (...)
                                | (...);
                            } & { Parameters?: (...)
                            | (...) } & { ResultPath?: (...) | (...) }
                            | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                        };
                    };
                    description?: string;
                    flow_administrators?: string[];
                    flow_owner?: string;
                    flow_starters?: string[];
                    flow_url?: string;
                    flow_viewers?: string[];
                    globus_auth_scope?: string;
                    globus_auth_scopes_by_RunAs?: string[];
                    globus_auth_username?: string;
                    id?: string;
                    input_schema?: Record<string, unknown>;
                    keywords?: string[];
                    log_supported?: boolean;
                    principal_urn?: string;
                    subscription_id?: string;
                    subtitle?: string;
                    synchronous?: boolean;
                    title?: string;
                    types?: ("Action" | "Event")[];
                    updated_at?: string;
                    user_role?:
                        | "flow_owner"
                        | "flow_viewer"
                        | "flow_starter"
                        | "flow_administrator";
                },
            >,
        >
      • Parameters

        • Optionaloptions: {
              payload: {
                  definition: {
                      Comment?: string;
                      StartAt: string;
                      States: {
                          [key: string]:
                              | {
                                  Comment?: unknown;
                                  End?: unknown;
                                  InputPath?: unknown;
                                  Next?: unknown;
                                  Parameters?: unknown;
                                  ResultPath?: unknown;
                                  Type?: (...)
                                  | (...);
                              } & { End?: (...)
                              | (...)
                              | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                  InputPath?: (...) | (...);
                              } & { ResultPath?: (...)
                              | (...) }
                              | {
                                  ActionScope?: (...) | (...);
                                  ActionUrl: string;
                                  Catch?: unknown;
                                  Comment?: unknown;
                                  End?: unknown;
                                  ExceptionOnActionFailure: boolean;
                                  InputPath?: unknown;
                                  Next?: unknown;
                                  Parameters?: unknown;
                                  ResultPath?: unknown;
                                  RunAs?: (...) | (...);
                                  Type: string;
                                  WaitTime?: (...) | (...);
                              } & { End?: (...)
                              | (...)
                              | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                  InputPath?: (...) | (...);
                              } & { ResultPath?: (...)
                              | (...) } & { Catch?: (...) | (...) }
                              | {
                                  Comment?: unknown;
                                  Next?: string;
                                  Seconds?: number;
                                  SecondsPath?: string;
                                  Timestamp?: string;
                                  TimestampPath?: string;
                                  Type?: string;
                              }
                              | {
                                  Choices: ((...) & (...))[];
                                  Comment?: string;
                                  Default?: string;
                                  Type?: string;
                              }
                              | {
                                  Comment?: unknown;
                                  Next: string;
                                  Parameters: unknown;
                                  ResultPath: unknown;
                                  Type?: (...)
                                  | (...);
                              } & { Parameters?: (...)
                              | (...) } & { ResultPath?: (...) | (...) }
                              | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                      };
                  };
                  description?: string;
                  flow_administrators?: string[];
                  flow_starters?: string[];
                  flow_viewers?: string[];
                  input_schema?: Record<string, unknown>;
                  keywords?: string[];
                  run_managers?: string[];
                  run_monitors?: string[];
                  subscription_id?: string;
                  subtitle?: string;
                  title?: string;
              };
              query?: undefined;
          } & BaseServiceMethodOptions
        • OptionalsdkOptions: SDKOptions

        Returns Promise<
            JSONFetchResponse<
                {
                    api_version?: "1.0";
                    created_at?: string;
                    definition?: {
                        Comment?: string;
                        StartAt: string;
                        States: {
                            [key: string]: | {
                                Comment?: unknown;
                                End?: unknown;
                                InputPath?: unknown;
                                Next?: unknown;
                                Parameters?: unknown;
                                ResultPath?: unknown;
                                Type?: (...)
                                | (...);
                            } & { End?: (...)
                            | (...)
                            | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                InputPath?: (...) | (...);
                            } & { ResultPath?: (...)
                            | (...) }
                            | {
                                ActionScope?: (...) | (...);
                                ActionUrl: string;
                                Catch?: unknown;
                                Comment?: unknown;
                                End?: unknown;
                                ExceptionOnActionFailure: boolean;
                                InputPath?: unknown;
                                Next?: unknown;
                                Parameters?: unknown;
                                ResultPath?: unknown;
                                RunAs?: (...) | (...);
                                Type: string;
                                WaitTime?: (...) | (...);
                            } & { End?: (...)
                            | (...)
                            | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                InputPath?: (...) | (...);
                            } & { ResultPath?: (...)
                            | (...) } & { Catch?: (...) | (...) }
                            | {
                                Comment?: unknown;
                                Next?: string;
                                Seconds?: number;
                                SecondsPath?: string;
                                Timestamp?: string;
                                TimestampPath?: string;
                                Type?: string;
                            }
                            | {
                                Choices: ((...) & (...))[];
                                Comment?: string;
                                Default?: string;
                                Type?: string;
                            }
                            | {
                                Comment?: unknown;
                                Next: string;
                                Parameters: unknown;
                                ResultPath: unknown;
                                Type?: (...)
                                | (...);
                            } & { Parameters?: (...)
                            | (...) } & { ResultPath?: (...) | (...) }
                            | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                        };
                    };
                    description?: string;
                    flow_administrators?: string[];
                    flow_owner?: string;
                    flow_starters?: string[];
                    flow_url?: string;
                    flow_viewers?: string[];
                    globus_auth_scope?: string;
                    globus_auth_scopes_by_RunAs?: string[];
                    globus_auth_username?: string;
                    id?: string;
                    input_schema?: Record<string, unknown>;
                    keywords?: string[];
                    log_supported?: boolean;
                    principal_urn?: string;
                    subscription_id?: string;
                    subtitle?: string;
                    synchronous?: boolean;
                    title?: string;
                    types?: ("Action" | "Event")[];
                    updated_at?: string;
                    user_role?:
                        | "flow_owner"
                        | "flow_viewer"
                        | "flow_starter"
                        | "flow_administrator";
                },
            >,
        >