@globus/sdk 6.2.0 → 6.3.0-canary.2.34be3d1

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

@@ -8,7 +8,9 @@ export interface paths {
         };
         /**
          * Stream Access Points List
-         * @description Get a list of all stream access points
+         * @description Get a list of all stream access points.
+         *
+         *     If the user provides a UUID in filter_fulltext, test if it's a SAP UUID and return that SAP directly.
          */
         get: operations["stream_access_points_list_stream_access_points_get"];
         put?: never;
@@ -97,10 +99,239 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/bookmarks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Bookmarks List
+         * @description List the user's bookmarks. Bookmarks on High Assurance collections have
+         *     their paths redacted to null.
+         */
+        get: operations["bookmarks_list_bookmarks_get"];
+        put?: never;
+        /**
+         * Bookmarks Post
+         * @description Create a bookmark. Requires that the user has visibility on the collection
+         *     and is in session if the collection is High Assurance.
+         */
+        post: operations["bookmarks_post_bookmarks_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/bookmarks/{bookmark_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Bookmarks Get
+         * @description Get a bookmark by UUID. Requires that the user owns the bookmark and is in
+         *     session for the bookmark's collection if it is High Assurance.
+         */
+        get: operations["bookmarks_get_bookmarks__bookmark_id__get"];
+        put?: never;
+        post?: never;
+        /**
+         * Bookmarks Delete
+         * @description Delete a bookmark by UUID. Requires that the user owns the bookmark.
+         */
+        delete: operations["bookmarks_delete_bookmarks__bookmark_id__delete"];
+        options?: never;
+        head?: never;
+        /**
+         * Bookmarks Patch
+         * @description Update a bookmark by UUID. Requires that the user owns the bookmark and
+         *     is in session for the bookmark's collection if it is High Assurance.
+         */
+        patch: operations["bookmarks_patch_bookmarks__bookmark_id__patch"];
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /** BookmarkAttributes */
+        BookmarkAttributes: {
+            /**
+             * Name
+             * @description Name of the bookmark. Unique per user.
+             */
+            name: string;
+            /**
+             * Path
+             * @description Path to a directory on the collection.
+             */
+            path: string;
+        };
+        /** BookmarkCreateResource */
+        BookmarkCreateResource: {
+            /**
+             * Type
+             * @default Bookmark
+             * @constant
+             */
+            type: "Bookmark";
+            /** @description Attributes belonging to a bookmark */
+            attributes: components["schemas"]["BookmarkAttributes"];
+            /** @description Entities related to a bookmark */
+            relationships: components["schemas"]["BookmarkRelationships"];
+        };
+        /** BookmarkCreateTopLevel */
+        BookmarkCreateTopLevel: {
+            data: components["schemas"]["BookmarkCreateResource"];
+        };
+        /** BookmarkListResponseAttributes */
+        BookmarkListResponseAttributes: {
+            /**
+             * Name
+             * @description Name of the bookmark. Unique per user.
+             */
+            name: string;
+            /**
+             * Path
+             * @description Path to a directory on the collection.
+             */
+            path: string | null;
+        };
+        /** BookmarkListResponseResource */
+        BookmarkListResponseResource: {
+            /**
+             * Type
+             * @default Bookmark
+             * @constant
+             */
+            type: "Bookmark";
+            /**
+             * Id
+             * Format: uuid
+             * @description Unique identifier of the bookmark
+             */
+            id: string;
+            /** @description Attributes belonging to a bookmark */
+            attributes: components["schemas"]["BookmarkListResponseAttributes"];
+            /** @description Entities related to a bookmark */
+            relationships: components["schemas"]["BookmarkRelationships"];
+        };
+        /** BookmarkListResponseTopLevel */
+        BookmarkListResponseTopLevel: {
+            /** Data */
+            data: components["schemas"]["BookmarkListResponseResource"][];
+            links?: components["schemas"]["JsonAPIPaginationLinks"];
+            meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
+            /** Included */
+            included?: components["schemas"]["CollectionResponseResource"][];
+        };
+        /** BookmarkPatchAttributes */
+        BookmarkPatchAttributes: {
+            /**
+             * Name
+             * @description Name of the bookmark. Unique per user.
+             */
+            name: string | null;
+            /**
+             * Path
+             * @description Path to a directory on the collection.
+             */
+            path: string;
+        };
+        /** BookmarkPatchResource */
+        BookmarkPatchResource: {
+            /**
+             * Type
+             * @default Bookmark
+             * @constant
+             */
+            type: "Bookmark";
+            /** @description Attributes settable on a stream access point update */
+            attributes: components["schemas"]["BookmarkPatchAttributes"];
+        };
+        /** BookmarkPatchTopLevel */
+        BookmarkPatchTopLevel: {
+            data: components["schemas"]["BookmarkPatchResource"];
+        };
+        /** BookmarkRelationships */
+        BookmarkRelationships: {
+            /** @description Collection the bookmark is on */
+            collection: components["schemas"]["CollectionDataRelationship"];
+        };
+        /** BookmarkResponseResource */
+        BookmarkResponseResource: {
+            /**
+             * Type
+             * @default Bookmark
+             * @constant
+             */
+            type: "Bookmark";
+            /**
+             * Id
+             * Format: uuid
+             * @description Unique identifier of the bookmark
+             */
+            id: string;
+            /** @description Attributes belonging to a bookmark */
+            attributes: components["schemas"]["BookmarkAttributes"];
+            /** @description Entities related to a bookmark */
+            relationships: components["schemas"]["BookmarkRelationships"];
+        };
+        /** BookmarkResponseTopLevel */
+        BookmarkResponseTopLevel: {
+            meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
+            data: components["schemas"]["BookmarkResponseResource"];
+            /** Included */
+            included?: components["schemas"]["CollectionResponseResource"][];
+        };
+        /** CollectionAttributes */
+        CollectionAttributes: {
+            /** Display Name */
+            display_name: string;
+            /** High Assurance */
+            high_assurance: boolean;
+        };
+        /** CollectionDataRelationship */
+        CollectionDataRelationship: {
+            data: components["schemas"]["CollectionResourceIdentifier"];
+        };
+        /** CollectionResourceIdentifier */
+        CollectionResourceIdentifier: {
+            /**
+             * Type
+             * @default Collection
+             * @constant
+             */
+            type: "Collection";
+            /**
+             * Id
+             * Format: uuid
+             * @description Unique identifier of the collection
+             */
+            id: string;
+        };
+        /** CollectionResponseResource */
+        CollectionResponseResource: {
+            /**
+             * Type
+             * @default Collection
+             * @constant
+             */
+            type: "Collection";
+            /**
+             * Id
+             * Format: uuid
+             * @description Unique identifier of the collection
+             */
+            id: string;
+            /** @description Attributes belonging to a collection */
+            attributes: components["schemas"]["CollectionAttributes"];
+        };
         /** EndpointDataRelationship */
         EndpointDataRelationship: {
             data?: components["schemas"]["EndpointResourceIdentifier"] | null;
@@ -114,9 +345,10 @@ export interface components {
             type: string;
             /**
              * Id
+             * Format: uuid
              * @description Unique identifier for Globus Connect Server endpoint
              */
-            id?: string | null;
+            id: string;
         };
         /** HTTPValidationError */
         HTTPValidationError: {
@@ -136,25 +368,18 @@ export interface components {
             type: string;
             /**
              * Id
+             * Format: uuid
              * @description Unique identifier for a Globus Auth identity
              */
-            id?: string | null;
+            id: string;
         };
         /** JsonAPIPaginationLinks */
         JsonAPIPaginationLinks: {
             /** Next */
             next: string;
         };
-        /** JsonApiAbstractResourceIdentifier */
-        JsonApiAbstractResourceIdentifier: {
-            /** Type */
-            type: string;
-            /** Id */
-            id?: string | null;
-        };
-        /** JsonApiAbstractResourceResponseTopLevel */
-        JsonApiAbstractResourceResponseTopLevel: {
-            data?: components["schemas"]["JsonApiAbstractResourceIdentifier"] | null;
+        /** JsonApiAbstractResponseTopLevel */
+        JsonApiAbstractResponseTopLevel: {
             meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
         };
         /** JsonApiTopLevelMetaInformation */
@@ -223,7 +448,7 @@ export interface components {
         StreamAccessPointListingTopLevel: {
             /** Data */
             data: components["schemas"]["StreamAccessPointResponseResource"][];
-            links?: components["schemas"]["JsonAPIPaginationLinks"] | null;
+            links?: components["schemas"]["JsonAPIPaginationLinks"];
             meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
         };
         /** StreamAccessPointResourceIdentifier */
@@ -239,7 +464,7 @@ export interface components {
              * Format: uuid
              * @description Unique identifier of the stream access point
              */
-            id?: string;
+            id: string;
         };
         /** StreamAccessPointResponseRelationships */
         StreamAccessPointResponseRelationships: {
@@ -259,7 +484,7 @@ export interface components {
              * Format: uuid
              * @description Unique identifier of the stream access point
              */
-            id?: string;
+            id: string;
             /** @description Attributes belonging to a stream access point */
             attributes: components["schemas"]["StreamAccessPointAttributes"];
             /** @description Entities related to a stream access point */
@@ -267,8 +492,8 @@ export interface components {
         };
         /** StreamAccessPointResponseTopLevel */
         StreamAccessPointResponseTopLevel: {
-            data: components["schemas"]["StreamAccessPointResponseResource"];
             meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
+            data: components["schemas"]["StreamAccessPointResponseResource"];
         };
         /** TunnelEventAttributes */
         TunnelEventAttributes: {
@@ -303,7 +528,7 @@ export interface components {
         TunnelEventListingTopLevel: {
             /** Data */
             data: components["schemas"]["TunnelEventResponseResource"][];
-            links?: components["schemas"]["JsonAPIPaginationLinks"] | null;
+            links?: components["schemas"]["JsonAPIPaginationLinks"];
             meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
         };
         /** TunnelEventResponseResource */
@@ -318,7 +543,7 @@ export interface components {
              * Id
              * @description Unique identifier of the event
              */
-            id?: number;
+            id: number;
             /** @description Attributes of the event */
             attributes: components["schemas"]["TunnelEventAttributes"] | null;
         };
@@ -326,7 +551,7 @@ export interface components {
         TunnelListingTopLevel: {
             /** Data */
             data: components["schemas"]["TunnelResponseResource"][];
-            links?: components["schemas"]["JsonAPIPaginationLinks"] | null;
+            links?: components["schemas"]["JsonAPIPaginationLinks"];
             meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
         };
         /** TunnelPatchAttributes */
@@ -336,16 +561,16 @@ export interface components {
              * @description Updatable friendly identifier for the tunnel
              */
             label?: string | null;
-            /**
-             * Listener Ip Address
-             * @description IP address of listening LAN contact
-             */
-            listener_ip_address?: string | null;
             /**
              * Listener Port
              * @description Port number of listening LAN contact
              */
             listener_port?: number | null;
+            /**
+             * Listener Ip Address
+             * @description IP address of listening LAN contact
+             */
+            listener_ip_address?: string | null;
             /**
              * State
              * @description Short description of tunnel state
@@ -369,39 +594,39 @@ export interface components {
         };
         /** TunnelRequestAttributes */
         TunnelRequestAttributes: {
+            /**
+             * Label
+             * @description Updatable friendly identifier for the tunnel
+             */
+            label?: string | null;
+            /**
+             * Listener Port
+             * @description Port number of listening LAN contact
+             */
+            listener_port?: number | null;
+            /**
+             * Listener Ip Address
+             * @description IP address of listening LAN contact
+             */
+            listener_ip_address?: string | null;
             /**
              * Submission Id
              * Format: uuid
              * @description Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
              */
             submission_id: string;
-            /**
-             * Label
-             * @description Updatable friendly identifier for the tunnel
-             */
-            label?: string | null;
             /**
              * Lifetime Mins
              * @description Number of minutes the tunnel will exist once created
              * @default 360
              */
-            lifetime_mins: number | null;
+            lifetime_mins: number;
             /**
              * Restartable
              * @description Restart tunnel on failure
              * @default false
              */
             restartable: boolean;
-            /**
-             * Listener Ip Address
-             * @description IP address of listening LAN contact
-             */
-            listener_ip_address?: string | null;
-            /**
-             * Listener Port
-             * @description Port number of listening LAN contact
-             */
-            listener_port?: number | null;
         };
         /** TunnelRequestRelationships */
         TunnelRequestRelationships: {
@@ -429,39 +654,39 @@ export interface components {
         };
         /** TunnelResponseAttributes */
         TunnelResponseAttributes: {
+            /**
+             * Label
+             * @description Updatable friendly identifier for the tunnel
+             */
+            label?: string | null;
+            /**
+             * Listener Port
+             * @description Port number of listening LAN contact
+             */
+            listener_port?: number | null;
+            /**
+             * Listener Ip Address
+             * @description IP address of listening LAN contact
+             */
+            listener_ip_address?: string | null;
             /**
              * Submission Id
              * Format: uuid
              * @description Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
              */
             submission_id: string;
-            /**
-             * Label
-             * @description Updatable friendly identifier for the tunnel
-             */
-            label?: string | null;
             /**
              * Lifetime Mins
              * @description Number of minutes the tunnel will exist once created
              * @default 360
              */
-            lifetime_mins: number | null;
+            lifetime_mins: number;
             /**
              * Restartable
              * @description Restart tunnel on failure
              * @default false
              */
             restartable: boolean;
-            /**
-             * Listener Ip Address
-             * @description IP address of listening LAN contact
-             */
-            listener_ip_address?: string | null;
-            /**
-             * Listener Port
-             * @description Port number of listening LAN contact
-             */
-            listener_port?: number | null;
             /**
              * Initiator Ip Address
              * @description IP address of initiating LAN contact
@@ -474,9 +699,10 @@ export interface components {
             initiator_port?: number | null;
             /**
              * Created Time
+             * Format: date-time
              * @description Date and time when the tunnel was created
              */
-            created_time?: string | null;
+            created_time: string;
             /**
              * State
              * @description Short description of tunnel state
@@ -493,7 +719,7 @@ export interface components {
             /** @description Stream access point for initiator application */
             initiator: components["schemas"]["StreamAccessPointDataRelationship"];
             /** @description Globus Auth identity that created the tunnel */
-            owner?: components["schemas"]["IdentityDataRelationship"] | null;
+            owner: components["schemas"]["IdentityDataRelationship"];
         };
         /** TunnelResponseResource */
         TunnelResponseResource: {
@@ -508,16 +734,16 @@ export interface components {
              * Format: uuid
              * @description Unique identifier of the tunnel
              */
-            id?: string;
+            id: string;
             /** @description Attributes of the tunnel */
             attributes: components["schemas"]["TunnelResponseAttributes"];
             /** @description Entities related to the tunnel */
-            relationships?: components["schemas"]["TunnelResponseRelationships"];
+            relationships: components["schemas"]["TunnelResponseRelationships"];
         };
         /** TunnelResponseTopLevel */
         TunnelResponseTopLevel: {
-            data: components["schemas"]["TunnelResponseResource"];
             meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
+            data: components["schemas"]["TunnelResponseResource"];
         };
         /** ValidationError */
         ValidationError: {
@@ -527,6 +753,10 @@ export interface components {
             msg: string;
             /** Error Type */
             type: string;
+            /** Input */
+            input?: unknown;
+            /** Context */
+            ctx?: Record<string, unknown>;
         };
     };
     responses: never;
@@ -546,9 +776,11 @@ export interface operations {
                 "page[limit]"?: number;
                 /** @description Limit results to stream access points on Globus Connect Server endpoints where the user has an `administrator` role */
                 "filter[endpoint_admin]"?: boolean;
-                /** @description [
+                /**
+                 * @description [
                  *       "Limit results to stream access points that match on an attribute; each attribute is weighted equally"
-                 *     ] */
+                 *     ]
+                 */
                 "filter[fulltext]"?: string | null;
             };
             header?: never;
@@ -709,7 +941,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["JsonApiAbstractResourceResponseTopLevel"];
+                    "application/json": components["schemas"]["JsonApiAbstractResponseTopLevel"];
                 };
             };
             /** @description Validation Error */
@@ -792,5 +1024,174 @@ export interface operations {
             };
         };
     };
+    bookmarks_list_bookmarks_get: {
+        parameters: {
+            query?: {
+                /** @description Pagination marker. */
+                "page[marker]"?: string | null;
+                /** @description Limit to page size. */
+                "page[limit]"?: number;
+                /** @description Set to 'collection' to include collection information in the response */
+                include?: "collection" | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BookmarkListResponseTopLevel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    bookmarks_post_bookmarks_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BookmarkCreateTopLevel"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BookmarkResponseTopLevel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    bookmarks_get_bookmarks__bookmark_id__get: {
+        parameters: {
+            query?: {
+                /** @description Set to 'collection' to include collection information in the response */
+                include?: "collection" | null;
+            };
+            header?: never;
+            path: {
+                bookmark_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BookmarkResponseTopLevel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    bookmarks_delete_bookmarks__bookmark_id__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                bookmark_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiAbstractResponseTopLevel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    bookmarks_patch_bookmarks__bookmark_id__patch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                bookmark_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BookmarkPatchTopLevel"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BookmarkResponseTopLevel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
 }
 //# sourceMappingURL=transfer.d.ts.map