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

package/dist/esm/index.d.ts

@@ -1,77 +1,6 @@
 /**
  * @module @globus/sdk
  * @description `@globus/sdk` provides modules for interacting with the various APIs that make up the Globus platform.
- *
- * ### Key Concepts
- * - All service methods return a `Promise` that resolves to a [Fetch API Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
- *    - Under the hood, we are returning the result of a composed [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
- * - All service methods accept a `ServiceMethodOptions` object to pass query parameters, a payload, and headers.
- * - All service methods support a tail argument to pass options to the SDK, including the composed `fetch` call.
- *
- * #### Service Method Names
- *
- * Basic CRUD operations provided by services are exposed as the following:
- *
- * | Service Method Name | HTTP Method | Description                  | Example |
- * | --------------------| ----------- | ---------------------------- | ------- |
- * | `get`               | `GET`       | Fetch a single resource.     | `transfer.endpoint.get()` |
- * | `getAll`            | `GET`       | Fetch a list of resources.   | `flows.flows.getAll()`    |
- * | `create`            | `POST`      | Create a new resource.       | `gcs.roles.create()`      |
- * | `update`            | `PUT`       | Update an existing resource. | `gcs.endpoint.update()`   |
- * | `patch`             | `PATCH`     | Update an existing resource. | `gcs.endpoint.patch()`    |
- * | `remove`            | `DELETE`    | Delete an existing resource. | `gcs.collections.remove()`|
- *
- * Methods that do not map to obvious CRUD operations are named according to the resource. i.e., `groups.groups.getMyGroups()`, `transfer.endpointSearch()`, `search.query.post()`
- *
- * @example Using the SDK to search for endpoints via Transfer API.
- * ```ts
- * import { transfer } from "@globus/sdk";
- *
- * const result = await (
- *   await globus.transfer.endpointSearch(
- *     {
- *        query: { filter_fulltext: "Globus Tutorial" }
- *        headers: {
- *          Authorization: "Bearer MY_ACCESS_TOKEN",
- *        },
- *     },
- *     {
- *       fetch: {
- *         // Provide parameters to the underlying `fetch` call.
- *         // https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters
- *         options: {
- *           priority: "high"
- *         },
- *       },
- *     }
- *   )
- * ).json();
- * ```
- *
- * @example Using the SDK to fetch a single flow from the Flows API.
- * ```ts
- * import { flows } from "@globus/sdk";
- *
- * const result = await (await flows.flows.get("452bbea3-5e3b-45a5-af08-50179839a4e8")).json();
- *```
- *
- * ### Authorization
- *
- * While all methods support passing of `headers` and direct modification of the underlying `fetch` call, the SDK provides an {@link Authorization.AuthorizationManager | `AuthorizationManager`} that can be used to manage access tokens and handle the authorization process.
- *
- * @example Using the AuthorizationManager with a service method.
- * ```ts
- * import { transfer, authorization } from "@globus/sdk";
- * const manager = authorization.create({ ... });
- * const result = await (
- *   await globus.transfer.endpointSearch(
- *     {
- *        query: { filter_fulltext: "Globus Tutorial" },
- *        manager
- *     }
- *   )
- * ).json();
- *```
  */
 /**
  * Core

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AAEH;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,sBAAsB,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAC3C,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAE3C;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,2CAA2C,CAAC;AACjE,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEjE;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,sBAAsB,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAC3C,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAE3C;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,2CAA2C,CAAC;AACjE,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEjE;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC"}

package/dist/esm/index.js

@@ -1,77 +1,6 @@
 /**
  * @module @globus/sdk
  * @description `@globus/sdk` provides modules for interacting with the various APIs that make up the Globus platform.
- *
- * ### Key Concepts
- * - All service methods return a `Promise` that resolves to a [Fetch API Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
- *    - Under the hood, we are returning the result of a composed [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
- * - All service methods accept a `ServiceMethodOptions` object to pass query parameters, a payload, and headers.
- * - All service methods support a tail argument to pass options to the SDK, including the composed `fetch` call.
- *
- * #### Service Method Names
- *
- * Basic CRUD operations provided by services are exposed as the following:
- *
- * | Service Method Name | HTTP Method | Description                  | Example |
- * | --------------------| ----------- | ---------------------------- | ------- |
- * | `get`               | `GET`       | Fetch a single resource.     | `transfer.endpoint.get()` |
- * | `getAll`            | `GET`       | Fetch a list of resources.   | `flows.flows.getAll()`    |
- * | `create`            | `POST`      | Create a new resource.       | `gcs.roles.create()`      |
- * | `update`            | `PUT`       | Update an existing resource. | `gcs.endpoint.update()`   |
- * | `patch`             | `PATCH`     | Update an existing resource. | `gcs.endpoint.patch()`    |
- * | `remove`            | `DELETE`    | Delete an existing resource. | `gcs.collections.remove()`|
- *
- * Methods that do not map to obvious CRUD operations are named according to the resource. i.e., `groups.groups.getMyGroups()`, `transfer.endpointSearch()`, `search.query.post()`
- *
- * @example Using the SDK to search for endpoints via Transfer API.
- * ```ts
- * import { transfer } from "@globus/sdk";
- *
- * const result = await (
- *   await globus.transfer.endpointSearch(
- *     {
- *        query: { filter_fulltext: "Globus Tutorial" }
- *        headers: {
- *          Authorization: "Bearer MY_ACCESS_TOKEN",
- *        },
- *     },
- *     {
- *       fetch: {
- *         // Provide parameters to the underlying `fetch` call.
- *         // https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters
- *         options: {
- *           priority: "high"
- *         },
- *       },
- *     }
- *   )
- * ).json();
- * ```
- *
- * @example Using the SDK to fetch a single flow from the Flows API.
- * ```ts
- * import { flows } from "@globus/sdk";
- *
- * const result = await (await flows.flows.get("452bbea3-5e3b-45a5-af08-50179839a4e8")).json();
- *```
- *
- * ### Authorization
- *
- * While all methods support passing of `headers` and direct modification of the underlying `fetch` call, the SDK provides an {@link Authorization.AuthorizationManager | `AuthorizationManager`} that can be used to manage access tokens and handle the authorization process.
- *
- * @example Using the AuthorizationManager with a service method.
- * ```ts
- * import { transfer, authorization } from "@globus/sdk";
- * const manager = authorization.create({ ... });
- * const result = await (
- *   await globus.transfer.endpointSearch(
- *     {
- *        query: { filter_fulltext: "Globus Tutorial" },
- *        manager
- *     }
- *   )
- * ).json();
- *```
  */
 /**
  * Core

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AAEH;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,sBAAsB,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAC3C,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAE3C;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,2CAA2C,CAAC;AACjE,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEjE;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,sBAAsB,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAC3C,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAE3C;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,2CAA2C,CAAC;AACjE,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAC;AACrD,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEjE;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC"}

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

@@ -43,26 +43,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/v2/stats": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get Compute Stats
-         * @description Get various usage stats.
-         */
-        get: operations["get_compute_stats_v2_stats_get"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/v2/get_amqp_result_connection_url": {
         parameters: {
             query?: never;
@@ -265,7 +245,11 @@ export interface paths {
         post?: never;
         /**
          * Delete Endpoint
+         * @deprecated
          * @description Delete the endpoint.
+         *
+         *     DEPRECATED.  Use the HTTP DELETE verb against `/v3/endpoints/{endpoint_uuid}`
+         *     instead.
          */
         delete: operations["delete_endpoint_v2_endpoints__endpoint_uuid__delete"];
         options?: never;
@@ -401,7 +385,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/v3/endpoints": {
+    "/v3/endpoints/{endpoint_uuid}": {
         parameters: {
             query?: never;
             header?: never;
@@ -409,19 +393,30 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        put?: never;
         /**
-         * Register Endpoint
-         * @description Register a new endpoint
+         * Update Endpoint
+         * @description Check immutable flags against existing endpoint
          */
-        post: operations["register_endpoint_v3_endpoints_post"];
-        delete?: never;
+        put: operations["update_endpoint_v3_endpoints__endpoint_uuid__put"];
+        post?: never;
+        /**
+         * Delete Endpoint
+         * @description Delete the endpoint.
+         *
+         *     Delete the requested endpoint.  To succeed, the request must be from the identity
+         *     that owns the endpoint.  When this call returns, the endpoint, if online, will be
+         *     disconnected (all credentials revoked) and will not be able to be utilized again.
+         *
+         *     N.B. As this operation cannot be undone, the only recourse for a mistaken DELETE
+         *          request is to create a new endpoint in its stead.
+         */
+        delete: operations["delete_endpoint_v3_endpoints__endpoint_uuid__delete"];
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v3/endpoints/{endpoint_uuid}": {
+    "/v3/endpoints": {
         parameters: {
             query?: never;
             header?: never;
@@ -429,12 +424,12 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
+        put?: never;
         /**
-         * Update Endpoint
-         * @description Check immutable flags against existing endpoint
+         * Register Endpoint
+         * @description Register a new endpoint
          */
-        put: operations["update_endpoint_v3_endpoints__endpoint_uuid__put"];
-        post?: never;
+        post: operations["register_endpoint_v3_endpoints_post"];
         delete?: never;
         options?: never;
         head?: never;
@@ -734,19 +729,6 @@ export interface components {
          * @enum {string}
          */
         BuildStatus: "provided" | "submitted" | "initialized" | "queued" | "building" | "ready" | "failed";
-        /**
-         * ComputeStatsResponse
-         * @example {
-         *       "total_function_invocations": 100
-         *     }
-         */
-        ComputeStatsResponse: {
-            /**
-             * Total Function Invocations
-             * @description Total function invocations
-             */
-            total_function_invocations: number;
-        };
         /**
          * ComputeVersionResponse
          * @example {
@@ -2858,26 +2840,6 @@ export interface operations {
             };
         };
     };
-    get_compute_stats_v2_stats_get: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ComputeStatsResponse"];
-                };
-            };
-        };
-    };
     get_user_specific_result_amqp_url_v2_get_amqp_result_connection_url_get: {
         parameters: {
             query?: never;
@@ -3458,7 +3420,7 @@ export interface operations {
             };
         };
     };
-    register_endpoint_v3_endpoints_post: {
+    update_endpoint_v3_endpoints__endpoint_uuid__put: {
         parameters: {
             query?: never;
             header: {
@@ -3466,7 +3428,9 @@ export interface operations {
                 "x-forwarded-for"?: string;
                 "remote-addr"?: string;
             };
-            path?: never;
+            path: {
+                endpoint_uuid: string;
+            };
             cookie?: never;
         };
         requestBody: {
@@ -3502,6 +3466,15 @@ export interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {
@@ -3511,6 +3484,15 @@ export interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
             /** @description Unprocessable Entity */
             422: {
                 headers: {
@@ -3540,7 +3522,39 @@ export interface operations {
             };
         };
     };
-    update_endpoint_v3_endpoints__endpoint_uuid__put: {
+    delete_endpoint_v3_endpoints__endpoint_uuid__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Endpoint UUID */
+                endpoint_uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    register_endpoint_v3_endpoints_post: {
         parameters: {
             query?: never;
             header: {
@@ -3548,9 +3562,7 @@ export interface operations {
                 "x-forwarded-for"?: string;
                 "remote-addr"?: string;
             };
-            path: {
-                endpoint_uuid: string;
-            };
+            path?: never;
             cookie?: never;
         };
         requestBody: {
@@ -3586,15 +3598,6 @@ export interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
-            /** @description Forbidden */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
             /** @description Not Found */
             404: {
                 headers: {
@@ -3604,15 +3607,6 @@ export interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
-            /** @description Conflict */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
             /** @description Unprocessable Entity */
             422: {
                 headers: {