@globus/sdk 6.3.1-canary.9.5437474 → 6.4.0

package/dist/esm/open-api/types/flows.d.ts

@@ -7,7 +7,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Retrieve all Flows
+         * List Flows
          * @description Query the Flows service for a listing of Flows available to a user
          *     according to the permissions (role) they have on the Flow.
          */
@@ -179,8 +179,8 @@ export interface paths {
         };
         put?: never;
         /**
-         * Deploy a Flow
-         * @description Deploy a Flow and its schema.
+         * Create a Flow
+         * @description Create a Flow and its schema.
          */
         post: {
             parameters: {
@@ -256,10 +256,7 @@ export interface paths {
                 };
             };
             responses: {
-                /**
-                 * @description The Flow definition was successfully deployed onto the Flows
-                 *     service.
-                 */
+                /** @description The Flow was successfully created. */
                 201: {
                     headers: {
                         [name: string]: unknown;
@@ -268,14 +265,14 @@ export interface paths {
                         "application/json": components["schemas"]["FlowResponse"];
                     };
                 };
-                /** @description The requestor attempted to deploy a malformed Flow. */
+                /** @description The requestor attempted to create a malformed Flow. */
                 400: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content?: never;
                 };
-                /** @description The requestor is not authorized to deploy a Flow. */
+                /** @description The requestor is not authorized to create a Flow. */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -300,7 +297,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Validate a flow
+         * Validate a Flow
          * @description Validate a flow definition and its schema.
          */
         post: {
@@ -378,8 +375,8 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Retrieve a Flow
-         * @description Get a previously deployed Flow.
+         * Get a Flow by ID
+         * @description Get an existing Flow.
          */
         get: {
             parameters: {
@@ -429,7 +426,7 @@ export interface paths {
         };
         /**
          * Update a Flow
-         * @description Update a previously deployed Flow.
+         * @description Update an existing Flow.
          */
         put: {
             parameters: {
@@ -505,10 +502,7 @@ export interface paths {
                 };
             };
             responses: {
-                /**
-                 * @description The requestor has successfully authenticated and updated the target
-                 *     Flow definition.
-                 */
+                /** @description The Flow was successfully updated. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -517,31 +511,22 @@ export interface paths {
                         "application/json": components["schemas"]["FlowResponse"];
                     };
                 };
-                /**
-                 * @description The Flow definition update failed due to an attempt to perform a
-                 *     malformed update.
-                 */
-                400: {
+                /** @description The requestor does not have access to update the Flow. */
+                403: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content?: never;
                 };
-                /**
-                 * @description The requestor attempted to update a Flow for which they did not have
-                 *     access.
-                 */
-                403: {
+                /** @description The specified Flow does not exist. */
+                404: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content?: never;
                 };
-                /**
-                 * @description The requestor attempted to update a non-existent Flow, or the
-                 *     requestor did not have permissions to update a Flow.
-                 */
-                404: {
+                /** @description The Flow update failed due to a malformed request. */
+                422: {
                     headers: {
                         [name: string]: unknown;
                     };
@@ -551,8 +536,8 @@ export interface paths {
         };
         post?: never;
         /**
-         * Remove a Flow
-         * @description Remove a Flow from the Flow service.
+         * Delete a Flow
+         * @description Delete an existing Flow.
          */
         delete: {
             parameters: {
@@ -566,10 +551,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /**
-                 * @description The requestor has successfully removed the Flow from the Flows
-                 *     service.
-                 */
+                /** @description The Flow was successfully deleted. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -578,10 +560,7 @@ export interface paths {
                         "application/json": components["schemas"]["FlowResponse"];
                     };
                 };
-                /**
-                 * @description The requestor attempted to modify a Flow for which they did not have
-                 *     access.
-                 */
+                /** @description The requestor does not have access to delete the Flow. */
                 403: {
                     headers: {
                         [name: string]: unknown;
@@ -589,8 +568,8 @@ export interface paths {
                     content?: never;
                 };
                 /**
-                 * @description The requestor attempted to remove a non-existent Flow, or the
-                 *     requestor did not have permissions to remove the Flow.
+                 * @description The specified Flow does not exist,
+                 *     or the requestor does not have permissions to delete the Flow.
                  */
                 404: {
                     headers: {
@@ -644,7 +623,7 @@ export interface paths {
                 };
             };
             responses: {
-                /** @description The Run was successfully started. */
+                /** @description The Flow was successfully started. */
                 201: {
                     headers: {
                         [name: string]: unknown;
@@ -726,7 +705,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Validate a run
+         * Validate a Run
          * @description Validate that a run input body will pass the target flow's input schema validation (if any),
          *     that run metadata will meet the Flows service's metadata constraints,
          *     and that known scope requirements are met by the user's or client's Globus Auth token.
@@ -1335,7 +1314,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get a Flow's Runs
+         * List a Flow's Runs
          * @description Retrieve a listing of Runs launched from a particular Flow. If hitting
          *     the *\/actions endpoint, the response will list the Runs under a
          *     "actions" key. If hitting the *\/runs endpoint, the response will list
@@ -1534,7 +1513,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * List all Runs
+         * List Runs
          * @description Retrieve a listing of Actions/Runs launched across all Flows. If hitting
          *     the *\/actions endpoint, the response will list the Runs under a
          *     "actions" key. If hitting the *\/runs endpoint, the response will list
@@ -1798,7 +1777,7 @@ export interface paths {
             };
         };
         /**
-         * Update a Run's metadata
+         * Update a Run
          * @description Modify a Run's metadata.
          *
          *     By default only the Run initiator is able to modify a Run's metadata.
@@ -1954,7 +1933,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Update metadata for multiple Runs. */
+        /** Update metadata for multiple Runs */
         post: {
             parameters: {
                 query?: never;
@@ -2437,6 +2416,258 @@ export interface paths {
         };
         trace?: never;
     };
+    "/web_inputs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Web Inputs
+         * @description Retrieve a listing of Web Inputs available to a user based on their viewer or respondent role on each Web Input.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description An opaque token used to iterate through pages of returned Web Inputs. If provided, all other query arguments will be ignored. The marker encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial marker has been received. */
+                    marker?: string;
+                    /** @description The number of results to return in a single paged response. */
+                    per_page?: number;
+                    /** @description Return Web Inputs for which the user has one of the supplied roles. If multiple roles are specified (comma-separated), the user will have at least one of the specified roles on each Web Input returned. If not provided, Web Inputs for which the caller has either "viewer" or "respondent" role will be returned. */
+                    filter_roles?: ("viewer" | "respondent")[];
+                    /** @description Return Web Inputs that are in one of the supplied states. If multiple states are specified (comma-separated), Web Inputs in any of those states will be returned. If not provided, only "open" Web Inputs will be returned. */
+                    filter_states?: ("open" | "closed")[];
+                    /** @description Return only Web Inputs associated with the specified Flow IDs. Multiple IDs can be specified (comma-separated), up to a maximum of 10. */
+                    filter_flow_ids?: string[];
+                    /** @description Return only Web Inputs associated with the specified Run IDs. Multiple IDs can be specified (comma-separated), up to a maximum of 10. */
+                    filter_run_ids?: string[];
+                    /**
+                     * @description Ordering criteria to apply to the list of Web Inputs.
+                     *
+                     *     This field is a comma-separated list of sort criteria,
+                     *     and follows this syntax:
+                     *
+                     *     ```
+                     *     CRITERION1[,CRITERION2[,...]]
+                     *     ```
+                     *
+                     *     and each individual `CRITERION` follows this syntax:
+                     *
+                     *     ```
+                     *     FIELD ORDERING
+                     *     ```
+                     *
+                     *     The first value, `FIELD`, indicates the field to sort by;
+                     *     the second value, `ORDERING`, indicates the sorting order.
+                     *
+                     *     When additional comma-separated criteria are added,
+                     *     the first criterion will be used to sort the data;
+                     *     subsequent criteria will be applied for ties.
+                     *
+                     *     Supported fields are:
+                     *
+                     *     - `created_timestamp`
+                     *     - `edited_timestamp`
+                     *     - `closed_timestamp`
+                     *
+                     *     Supported orderings are:
+                     *
+                     *     - `ASC`
+                     *     - `DESC`
+                     */
+                    orderby?: components["parameters"]["list_web_inputs_orderby"];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The requestor has successfully authenticated and queried the Flows service for the Web Inputs available for them. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            web_input_summaries: components["schemas"]["WebInputSummary"][];
+                            /** @description An opaque pagination token for iterating through returned Web Inputs. Null if there are no more pages. */
+                            marker?: string | null;
+                        };
+                    };
+                };
+                /** @description There was an issue parsing the query parameters. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The requestor presented a token with insufficient scopes. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The request's query parameters did not pass validation. */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/web_inputs/{web_input_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get a Web Input by ID */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    web_input_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Information about the Web Input */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["WebInputResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/web_inputs/{web_input_id}/respond": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Respond to a Web Input
+         * @description Submit a response to a Web Input. The caller must have the respondent role on the Web Input and satisfy any authentication policy on the associated flow.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The unique identifier of the Web Input to respond to. */
+                    web_input_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        response: {
+                            /** @description The response value submitted by the user. */
+                            value: unknown;
+                        };
+                    };
+                };
+            };
+            responses: {
+                /** @description The response was successfully submitted. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {string} */
+                            status?: "ok";
+                        };
+                    };
+                };
+                /**
+                 * @description The requestor does not have the respondent role on the Web Input,
+                 *     or the requestor does not satisfy the flow's authentication policy.
+                 *     When the user has the respondent role but fails the authentication
+                 *     policy, the response includes a web_input_summary alongside a GARE.
+                 */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                code: string;
+                                detail: string;
+                            };
+                        } | {
+                            web_input_summary?: components["schemas"]["WebInputSummary"];
+                            code?: string;
+                            authorization_parameters?: Record<string, unknown>;
+                            error?: {
+                                code?: string;
+                                detail?: string;
+                            };
+                        };
+                    };
+                };
+                /** @description The Web Input does not exist. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The Web Input is already closed. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The request body did not pass validation. */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2505,6 +2736,8 @@ export interface components {
             /** @description The list of all roles the requesting user has on the Run. */
             user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
             tags: components["schemas"]["Tags"];
+            /** @description The ID of the Web Input from which the Run is currently awaiting input. This field is present, but null, if the Run is not awaiting input. */
+            blocking_web_input_id: string | null;
         };
         ValidateRun: {
             /**
@@ -2939,6 +3172,149 @@ export interface components {
              */
             updated_timestamp: string;
         };
+        /**
+         * Format: date-time
+         * @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was closed. Null if the Web Input is still open.
+         */
+        _WebInputClosedTimestamp: string | null;
+        _WebInputContext: components["schemas"]["_WebInputTableContext"] | components["schemas"]["_WebInputTextContext"];
+        /**
+         * @description Information that helps respondents understand what they're responding to.
+         *     For example, "What file transfer am I approving or denying?"
+         */
+        _WebInputTableContext: {
+            /**
+             * @description A title for the Web Input.
+             *     This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.
+             */
+            title: string;
+            /**
+             * @description The value "table" indicating that clients should present data as a table. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            presentation_style: "table";
+            rows: {
+                field: string;
+                value: string;
+            }[];
+        };
+        /**
+         * @description Information that helps respondents understand what they're responding to.
+         *     For example, "What file transfer am I approving or denying?"
+         */
+        _WebInputTextContext: {
+            /**
+             * @description A title for the Web Input.
+             *     This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.
+             */
+            title: string;
+            /**
+             * @description The value "text" indicating that clients should present data as a block of text. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            presentation_style: "text";
+            text: string;
+        };
+        /** @description The Globus Auth identity that created the Web Input. Creators are not implicitly granted "view" access to the Web Input. */
+        _WebInputCreatorUrn: string;
+        /**
+         * Format: date-time
+         * @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was created.
+         */
+        _WebInputCreatedTimestamp: string;
+        /**
+         * Format: date-time
+         * @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was last edited.
+         */
+        _WebInputEditedTimestamp: string;
+        /** @description Info about the Flow associated with the Web Input. */
+        _WebInputFlowInfo: {
+            /**
+             * Format: uuid
+             * @description The unique identifier for the associated Flow.
+             */
+            id: string;
+            /** @description The title of the associated Flow. */
+            title: string;
+        };
+        /**
+         * Format: uuid
+         * @description The unique identifier for the Web Input.
+         */
+        _WebInputId: string;
+        /** @description The input schema used to validate all responses to the Web Input. */
+        _WebInputInputSchema: Record<string, unknown>;
+        /**
+         * @description The type of Web Input.
+         * @enum {string}
+         */
+        _WebInputInputType: "selection";
+        /** @description The individual options associated with Web Input. This field is only present when the input type is "selection". */
+        _WebInputOptions: {
+            /**
+             * Format: uuid
+             * @description A UUID that identifies the option. If a respondent selects this option (like "Approve" or "Deny"), this is the value that should be submitted back to the Flows service.
+             */
+            option_id: string;
+            /** @description Text that is associated with the option. For example, this may be the word "Approve" or "Deny", and is probably displayed prominently on a button or other UI element that respondents can click on. */
+            label: string;
+            /** @description Additional context to clarify the option for respondents. For example, this may be text "Allow file egress from the protected collection." */
+            description: string;
+        }[];
+        /** @description The Globus Auth identities and groups that have been assigned roles/permissions to the Web Input. */
+        _WebInputRoles: {
+            /** @description Identities and groups that are allowed to view all of the Web Input's information. */
+            viewer_urns: string[];
+            /** @description Identities and groups that are allowed to submit responses to the Web Input. Respondents are also allowed to view information about the Web Input. */
+            respondent_urns: string[];
+        };
+        /** @description Info about the Run associated with the Web Input. */
+        _WebInputRunInfo: {
+            /**
+             * Format: uuid
+             * @description The unique identifier for the associated Run.
+             */
+            id: string;
+            /** @description An optional label for the associated Run. */
+            label: string | null;
+        };
+        /**
+         * @description The current status of the Web Input. "open" indicates the Web Input is awaiting a response; "closed" indicates it has been completed.
+         * @enum {string}
+         */
+        _WebInputStatus: "open" | "closed";
+        /** @description A human-readable title for the Web Input. */
+        _WebInputTitle: string;
+        /** @description The roles the current user has on this Web Input. */
+        _WebInputUserRoles: ("viewer" | "respondent")[];
+        WebInputResponse: {
+            id: components["schemas"]["_WebInputId"];
+            status: components["schemas"]["_WebInputStatus"];
+            user_roles: components["schemas"]["_WebInputUserRoles"];
+            input_type: components["schemas"]["_WebInputInputType"];
+            input_schema: components["schemas"]["_WebInputInputSchema"];
+            context: components["schemas"]["_WebInputContext"];
+            flow: components["schemas"]["_WebInputFlowInfo"];
+            run: components["schemas"]["_WebInputRunInfo"];
+            roles: components["schemas"]["_WebInputRoles"];
+            creator_urn: components["schemas"]["_WebInputCreatorUrn"];
+            created_timestamp: components["schemas"]["_WebInputCreatedTimestamp"];
+            edited_timestamp: components["schemas"]["_WebInputEditedTimestamp"];
+            closed_timestamp: components["schemas"]["_WebInputClosedTimestamp"];
+            options?: components["schemas"]["_WebInputOptions"];
+        };
+        WebInputSummary: {
+            id: components["schemas"]["_WebInputId"];
+            status: components["schemas"]["_WebInputStatus"];
+            user_roles: components["schemas"]["_WebInputUserRoles"];
+            input_type: components["schemas"]["_WebInputInputType"];
+            title: components["schemas"]["_WebInputTitle"];
+            flow: components["schemas"]["_WebInputFlowInfo"];
+            run: components["schemas"]["_WebInputRunInfo"];
+            created_timestamp: components["schemas"]["_WebInputCreatedTimestamp"];
+            edited_timestamp: components["schemas"]["_WebInputEditedTimestamp"];
+            closed_timestamp: components["schemas"]["_WebInputClosedTimestamp"];
+        };
         RegisteredApi: components["schemas"]["RegisteredApiSummary"] & {
             /**
              * @description Access control roles for the Registered API, mapping role names to
@@ -3242,6 +3618,41 @@ export interface components {
          *     - `DESC`
          */
         list_registered_apis_orderby: string[];
+        /**
+         * @description Ordering criteria to apply to the list of Web Inputs.
+         *
+         *     This field is a comma-separated list of sort criteria,
+         *     and follows this syntax:
+         *
+         *     ```
+         *     CRITERION1[,CRITERION2[,...]]
+         *     ```
+         *
+         *     and each individual `CRITERION` follows this syntax:
+         *
+         *     ```
+         *     FIELD ORDERING
+         *     ```
+         *
+         *     The first value, `FIELD`, indicates the field to sort by;
+         *     the second value, `ORDERING`, indicates the sorting order.
+         *
+         *     When additional comma-separated criteria are added,
+         *     the first criterion will be used to sort the data;
+         *     subsequent criteria will be applied for ties.
+         *
+         *     Supported fields are:
+         *
+         *     - `created_timestamp`
+         *     - `edited_timestamp`
+         *     - `closed_timestamp`
+         *
+         *     Supported orderings are:
+         *
+         *     - `ASC`
+         *     - `DESC`
+         */
+        list_web_inputs_orderby: string[];
     };
     requestBodies: never;
     headers: never;