@globus/sdk 6.4.0 → 6.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist/cjs/core/authorization/index.js +19 -5
  2. package/dist/cjs/core/authorization/index.js.map +4 -4
  3. package/dist/cjs/core/info/index.js +1 -1
  4. package/dist/cjs/core/info/index.js.map +1 -1
  5. package/dist/cjs/index.js +68 -9
  6. package/dist/cjs/index.js.map +4 -4
  7. package/dist/cjs/services/globus-connect-server/client.js +19 -5
  8. package/dist/cjs/services/globus-connect-server/client.js.map +4 -4
  9. package/dist/esm/apps/web.d.ts +1 -1
  10. package/dist/esm/apps/web.d.ts.map +1 -1
  11. package/dist/esm/apps/web.js +3 -0
  12. package/dist/esm/apps/web.js.map +1 -1
  13. package/dist/esm/core/authorization/TokenManager.js.map +1 -1
  14. package/dist/esm/core/global.d.ts +1 -0
  15. package/dist/esm/core/global.d.ts.map +1 -1
  16. package/dist/esm/core/global.js +3 -0
  17. package/dist/esm/core/global.js.map +1 -1
  18. package/dist/esm/core/info/version.d.ts +1 -1
  19. package/dist/esm/core/info/version.js +1 -1
  20. package/dist/esm/core/url.d.ts.map +1 -1
  21. package/dist/esm/core/url.js.map +1 -1
  22. package/dist/esm/index.d.ts +1 -0
  23. package/dist/esm/index.d.ts.map +1 -1
  24. package/dist/esm/index.js +1 -0
  25. package/dist/esm/index.js.map +1 -1
  26. package/dist/esm/open-api/types/compute.d.ts +15 -5
  27. package/dist/esm/open-api/types/compute.d.ts.map +1 -1
  28. package/dist/esm/open-api/types/flows.d.ts +4 -5
  29. package/dist/esm/open-api/types/flows.d.ts.map +1 -1
  30. package/dist/esm/open-api/types/gcs/v5.4.d.ts +330 -13
  31. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
  32. package/dist/esm/open-api/types/search.d.ts +83 -6
  33. package/dist/esm/open-api/types/search.d.ts.map +1 -1
  34. package/dist/esm/open-api/types/transfer.d.ts +335 -244
  35. package/dist/esm/open-api/types/transfer.d.ts.map +1 -1
  36. package/dist/esm/package.json +1 -1
  37. package/dist/esm/services/auth/service/developers/clients/index.d.ts.map +1 -1
  38. package/dist/esm/services/auth/service/developers/clients/index.js.map +1 -1
  39. package/dist/esm/services/auth/service/oauth2/token.d.ts.map +1 -1
  40. package/dist/esm/services/auth/service/oauth2/token.js.map +1 -1
  41. package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
  42. package/dist/esm/services/downloads/config.d.ts +4 -0
  43. package/dist/esm/services/downloads/config.d.ts.map +1 -0
  44. package/dist/esm/services/downloads/config.js +10 -0
  45. package/dist/esm/services/downloads/config.js.map +1 -0
  46. package/dist/esm/services/downloads/index.d.ts +71 -0
  47. package/dist/esm/services/downloads/index.d.ts.map +1 -0
  48. package/dist/esm/services/downloads/index.js +40 -0
  49. package/dist/esm/services/downloads/index.js.map +1 -0
  50. package/dist/esm/services/flows/service/flows.d.ts +1 -1
  51. package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
  52. package/dist/esm/services/flows/service/runs.d.ts +4 -4
  53. package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
  54. package/dist/esm/services/flows/service/web-inputs.d.ts.map +1 -1
  55. package/dist/esm/services/globus-connect-server/client.d.ts +54 -8
  56. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  57. package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
  58. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +23 -0
  59. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
  60. package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
  61. package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
  62. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +4 -4
  63. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
  64. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
  65. package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
  66. package/dist/esm/services/search/service/task.d.ts.map +1 -1
  67. package/dist/esm/services/shared.d.ts.map +1 -1
  68. package/dist/esm/services/shared.js +6 -2
  69. package/dist/esm/services/shared.js.map +1 -1
  70. package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
  71. package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
  72. package/dist/esm/services/transfer/service/stream-access-point.d.ts +3 -3
  73. package/dist/esm/services/transfer/service/stream-access-point.d.ts.map +1 -1
  74. package/dist/esm/services/transfer/service/tunnel.d.ts +9 -9
  75. package/dist/esm/services/transfer/service/tunnel.d.ts.map +1 -1
  76. package/dist/esm/services/transfer/service/v2/bookmarks.d.ts +10 -10
  77. package/dist/esm/services/transfer/service/v2/bookmarks.d.ts.map +1 -1
  78. package/dist/umd/globus.production.js +2 -2
  79. package/dist/umd/globus.production.js.map +4 -4
  80. package/package.json +24 -19
@@ -159,38 +159,60 @@ export interface paths {
159
159
  export type webhooks = Record<string, never>;
160
160
  export interface components {
161
161
  schemas: {
162
- /** BookmarkAttributes */
163
- BookmarkAttributes: {
162
+ /** AbstractResourceIdentifier[Literal['Collection']] */
163
+ AbstractResourceIdentifier_Literal__Collection___: {
164
164
  /**
165
- * Name
166
- * @description Name of the bookmark. Unique per user.
165
+ * Type
166
+ * @constant
167
167
  */
168
- name: string;
168
+ type: "Collection";
169
169
  /**
170
- * Path
171
- * @description Path to a directory on the collection.
170
+ * Id
171
+ * Format: uuid
172
172
  */
173
- path: string;
173
+ id: string;
174
174
  };
175
- /** BookmarkCreateResource */
176
- BookmarkCreateResource: {
175
+ /** AbstractResourceIdentifier[Literal['Endpoint']] */
176
+ AbstractResourceIdentifier_Literal__Endpoint___: {
177
177
  /**
178
178
  * Type
179
- * @default Bookmark
180
179
  * @constant
181
180
  */
182
- type: "Bookmark";
183
- /** @description Attributes belonging to a bookmark */
184
- attributes: components["schemas"]["BookmarkAttributes"];
185
- /** @description Entities related to a bookmark */
186
- relationships: components["schemas"]["BookmarkRelationships"];
181
+ type: "Endpoint";
182
+ /**
183
+ * Id
184
+ * Format: uuid
185
+ */
186
+ id: string;
187
187
  };
188
- /** BookmarkCreateTopLevel */
189
- BookmarkCreateTopLevel: {
190
- data: components["schemas"]["BookmarkCreateResource"];
188
+ /** AbstractResourceIdentifier[Literal['Identity']] */
189
+ AbstractResourceIdentifier_Literal__Identity___: {
190
+ /**
191
+ * Type
192
+ * @constant
193
+ */
194
+ type: "Identity";
195
+ /**
196
+ * Id
197
+ * Format: uuid
198
+ */
199
+ id: string;
191
200
  };
192
- /** BookmarkListResponseAttributes */
193
- BookmarkListResponseAttributes: {
201
+ /** AbstractResourceIdentifier[Literal['StreamAccessPoint']] */
202
+ AbstractResourceIdentifier_Literal__StreamAccessPoint___: {
203
+ /**
204
+ * Type
205
+ * @constant
206
+ */
207
+ type: "StreamAccessPoint";
208
+ /**
209
+ * Id
210
+ * Format: uuid
211
+ */
212
+ id: string;
213
+ };
214
+ /** BookmarkAttributes[str] */
215
+ BookmarkAttributes_str_: {
194
216
  /**
195
217
  * Name
196
218
  * @description Name of the bookmark. Unique per user.
@@ -200,70 +222,95 @@ export interface components {
200
222
  * Path
201
223
  * @description Path to a directory on the collection.
202
224
  */
203
- path: string | null;
225
+ path: string;
204
226
  };
205
- /** BookmarkListResponseResource */
206
- BookmarkListResponseResource: {
227
+ /**
228
+ * BookmarkCreateRequest
229
+ * @description Top-level POST request body for bookmark creation.
230
+ */
231
+ BookmarkCreateRequest: {
232
+ data: components["schemas"]["BookmarkCreateResource"];
233
+ };
234
+ /**
235
+ * BookmarkCreateResource
236
+ * @description Bookmark resource for POST request bodies.
237
+ */
238
+ BookmarkCreateResource: {
207
239
  /**
208
240
  * Type
209
241
  * @default Bookmark
210
242
  * @constant
211
243
  */
212
244
  type: "Bookmark";
213
- /**
214
- * Id
215
- * Format: uuid
216
- * @description Unique identifier of the bookmark
217
- */
218
- id: string;
219
- /** @description Attributes belonging to a bookmark */
220
- attributes: components["schemas"]["BookmarkListResponseAttributes"];
221
- /** @description Entities related to a bookmark */
222
- relationships: components["schemas"]["BookmarkRelationships"];
223
- };
224
- /** BookmarkListResponseTopLevel */
225
- BookmarkListResponseTopLevel: {
226
- /** Data */
227
- data: components["schemas"]["BookmarkListResponseResource"][];
228
- links?: components["schemas"]["JsonAPIPaginationLinks"];
229
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
230
- /** Included */
231
- included?: components["schemas"]["CollectionResponseResource"][];
245
+ attributes: components["schemas"]["BookmarkAttributes_str_"];
246
+ relationships?: components["schemas"]["BookmarkRelationships"] | null;
232
247
  };
233
- /** BookmarkPatchAttributes */
234
- BookmarkPatchAttributes: {
248
+ /** BookmarkListAttributes */
249
+ BookmarkListAttributes: {
235
250
  /**
236
251
  * Name
237
252
  * @description Name of the bookmark. Unique per user.
238
253
  */
239
- name: string | null;
254
+ name: string;
240
255
  /**
241
256
  * Path
242
257
  * @description Path to a directory on the collection.
243
258
  */
244
- path: string;
259
+ path?: string | null;
260
+ };
261
+ /**
262
+ * BookmarkListResponse
263
+ * @description Top-level response for a list of bookmarks.
264
+ */
265
+ BookmarkListResponse: {
266
+ /** Included */
267
+ included?: components["schemas"]["CollectionResponseResource"][] | null;
268
+ /** Data */
269
+ data: components["schemas"]["BookmarkListResponseResource"][];
270
+ links?: components["schemas"]["PaginationLinks"] | null;
271
+ meta: components["schemas"]["TopLevelMeta"];
245
272
  };
246
- /** BookmarkPatchResource */
247
- BookmarkPatchResource: {
273
+ /**
274
+ * BookmarkListResponseResource
275
+ * @description Bookmark resource returned in list responses. path may be None for HA collections.
276
+ */
277
+ BookmarkListResponseResource: {
248
278
  /**
249
279
  * Type
250
280
  * @default Bookmark
251
281
  * @constant
252
282
  */
253
283
  type: "Bookmark";
254
- /** @description Attributes settable on a stream access point update */
255
- attributes: components["schemas"]["BookmarkPatchAttributes"];
256
- };
257
- /** BookmarkPatchTopLevel */
258
- BookmarkPatchTopLevel: {
259
- data: components["schemas"]["BookmarkPatchResource"];
284
+ /**
285
+ * Id
286
+ * Format: uuid
287
+ */
288
+ id: string;
289
+ attributes: components["schemas"]["BookmarkListAttributes"];
290
+ relationships?: components["schemas"]["BookmarkRelationships"] | null;
260
291
  };
261
- /** BookmarkRelationships */
292
+ /**
293
+ * BookmarkRelationships
294
+ * @description Relationships for a bookmark resource.
295
+ */
262
296
  BookmarkRelationships: {
263
297
  /** @description Collection the bookmark is on */
264
298
  collection: components["schemas"]["CollectionDataRelationship"];
265
299
  };
266
- /** BookmarkResponseResource */
300
+ /**
301
+ * BookmarkResponse
302
+ * @description Top-level response for a single bookmark.
303
+ */
304
+ BookmarkResponse: {
305
+ /** Included */
306
+ included?: components["schemas"]["CollectionResponseResource"][] | null;
307
+ data: components["schemas"]["BookmarkResponseResource"];
308
+ meta: components["schemas"]["TopLevelMeta"];
309
+ };
310
+ /**
311
+ * BookmarkResponseResource
312
+ * @description Bookmark resource returned in single-resource responses.
313
+ */
267
314
  BookmarkResponseResource: {
268
315
  /**
269
316
  * Type
@@ -274,131 +321,129 @@ export interface components {
274
321
  /**
275
322
  * Id
276
323
  * Format: uuid
277
- * @description Unique identifier of the bookmark
278
324
  */
279
325
  id: string;
280
- /** @description Attributes belonging to a bookmark */
281
- attributes: components["schemas"]["BookmarkAttributes"];
282
- /** @description Entities related to a bookmark */
283
- relationships: components["schemas"]["BookmarkRelationships"];
284
- };
285
- /** BookmarkResponseTopLevel */
286
- BookmarkResponseTopLevel: {
287
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
288
- data: components["schemas"]["BookmarkResponseResource"];
289
- /** Included */
290
- included?: components["schemas"]["CollectionResponseResource"][];
326
+ attributes: components["schemas"]["BookmarkAttributes_str_"];
327
+ relationships?: components["schemas"]["BookmarkRelationships"] | null;
328
+ };
329
+ /** BookmarkUpdateAttributes */
330
+ BookmarkUpdateAttributes: {
331
+ /**
332
+ * Name
333
+ * @description Name of the bookmark. Unique per user.
334
+ */
335
+ name?: string | null;
336
+ /**
337
+ * Path
338
+ * @description Path to a directory on the collection.
339
+ */
340
+ path?: string | null;
291
341
  };
292
- /** CollectionAttributes */
342
+ /**
343
+ * BookmarkUpdateRequest
344
+ * @description Top-level PATCH request body for bookmark update.
345
+ */
346
+ BookmarkUpdateRequest: {
347
+ data: components["schemas"]["BookmarkUpdateResource"];
348
+ };
349
+ /**
350
+ * BookmarkUpdateResource
351
+ * @description Bookmark resource for PATCH request bodies.
352
+ */
353
+ BookmarkUpdateResource: {
354
+ /** Id */
355
+ id?: string | null;
356
+ /**
357
+ * Type
358
+ * @default Bookmark
359
+ * @constant
360
+ */
361
+ type: "Bookmark";
362
+ attributes: components["schemas"]["BookmarkUpdateAttributes"];
363
+ };
364
+ /**
365
+ * CollectionAttributes
366
+ * @description Collection attributes. Note: only exposes fields relevant to including features.
367
+ */
293
368
  CollectionAttributes: {
294
369
  /** Display Name */
295
370
  display_name: string;
296
371
  /** High Assurance */
297
372
  high_assurance: boolean;
298
373
  };
299
- /** CollectionDataRelationship */
374
+ /**
375
+ * CollectionDataRelationship
376
+ * @description Relationship to a Globus collection.
377
+ */
300
378
  CollectionDataRelationship: {
301
- data: components["schemas"]["CollectionResourceIdentifier"];
302
- };
303
- /** CollectionResourceIdentifier */
304
- CollectionResourceIdentifier: {
305
- /**
306
- * Type
307
- * @default Collection
308
- * @constant
309
- */
310
- type: "Collection";
311
- /**
312
- * Id
313
- * Format: uuid
314
- * @description Unique identifier of the collection
315
- */
316
- id: string;
379
+ /** Data */
380
+ data: components["schemas"]["AbstractResourceIdentifier_Literal__Collection___"] | components["schemas"]["AbstractResourceIdentifier_Literal__Collection___"][];
317
381
  };
318
- /** CollectionResponseResource */
382
+ /**
383
+ * CollectionResponseResource
384
+ * @description Collection resource, used as an included resource in other feature responses.
385
+ */
319
386
  CollectionResponseResource: {
320
387
  /**
321
388
  * Type
322
- * @default Collection
323
389
  * @constant
324
390
  */
325
391
  type: "Collection";
326
392
  /**
327
393
  * Id
328
394
  * Format: uuid
329
- * @description Unique identifier of the collection
330
395
  */
331
396
  id: string;
332
- /** @description Attributes belonging to a collection */
333
397
  attributes: components["schemas"]["CollectionAttributes"];
398
+ /** Relationships */
399
+ relationships?: null;
334
400
  };
335
- /** EndpointDataRelationship */
401
+ /**
402
+ * EndpointDataRelationship
403
+ * @description Relationship to a Globus Connect Server endpoint.
404
+ */
336
405
  EndpointDataRelationship: {
337
- data?: components["schemas"]["EndpointResourceIdentifier"] | null;
338
- };
339
- /** EndpointResourceIdentifier */
340
- EndpointResourceIdentifier: {
341
- /**
342
- * Type
343
- * @default Endpoint
344
- */
345
- type: string;
346
- /**
347
- * Id
348
- * Format: uuid
349
- * @description Unique identifier for Globus Connect Server endpoint
350
- */
351
- id: string;
406
+ /** Data */
407
+ data: components["schemas"]["AbstractResourceIdentifier_Literal__Endpoint___"] | components["schemas"]["AbstractResourceIdentifier_Literal__Endpoint___"][];
352
408
  };
353
409
  /** HTTPValidationError */
354
410
  HTTPValidationError: {
355
411
  /** Detail */
356
412
  detail?: components["schemas"]["ValidationError"][];
357
413
  };
358
- /** IdentityDataRelationship */
414
+ /**
415
+ * IdentityDataRelationship
416
+ * @description Relationship to a Globus Auth identity.
417
+ */
359
418
  IdentityDataRelationship: {
360
- data?: components["schemas"]["IdentityResourceIdentifier"] | null;
419
+ /** Data */
420
+ data: components["schemas"]["AbstractResourceIdentifier_Literal__Identity___"] | components["schemas"]["AbstractResourceIdentifier_Literal__Identity___"][];
361
421
  };
362
- /** IdentityResourceIdentifier */
363
- IdentityResourceIdentifier: {
422
+ /** Link */
423
+ Link: {
364
424
  /**
365
- * Type
366
- * @default Identity
425
+ * Href
426
+ * @description URI-reference pointing to link target
367
427
  */
368
- type: string;
369
- /**
370
- * Id
371
- * Format: uuid
372
- * @description Unique identifier for a Globus Auth identity
373
- */
374
- id: string;
375
- };
376
- /** JsonAPIPaginationLinks */
377
- JsonAPIPaginationLinks: {
378
- /** Next */
379
- next: string;
428
+ href: string;
380
429
  };
381
- /** JsonApiAbstractResponseTopLevel */
382
- JsonApiAbstractResponseTopLevel: {
383
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
430
+ /**
431
+ * MetaDocument
432
+ * @description Top-level JSONAPI response with no data, only meta.
433
+ */
434
+ MetaDocument: {
435
+ meta: components["schemas"]["TopLevelMeta"];
384
436
  };
385
- /** JsonApiTopLevelMetaInformation */
386
- JsonApiTopLevelMetaInformation: {
387
- /** Request Id */
388
- request_id: string;
437
+ /** PaginationLinks */
438
+ PaginationLinks: {
439
+ /** Next */
440
+ next?: string | components["schemas"]["Link"] | null;
389
441
  };
390
- /** StreamAccessPointAttributes */
442
+ /**
443
+ * StreamAccessPointAttributes
444
+ * @description Attributes for SAP create and response.
445
+ */
391
446
  StreamAccessPointAttributes: {
392
- /**
393
- * Display Name
394
- * @description Friendly name to show in stream access point listings
395
- */
396
- display_name: string;
397
- /**
398
- * Tlsftp Server
399
- * @description URL for the tlsftp server used for tunnel access; must begin with tlsftp and end with a port number
400
- */
401
- tlsftp_server: string;
402
447
  /**
403
448
  * Advertised Owner
404
449
  * @description Globus Auth username for the advertised owner identity
@@ -439,39 +484,55 @@ export interface components {
439
484
  * @description Organization which operates the stream access point
440
485
  */
441
486
  organization?: string | null;
487
+ /**
488
+ * Display Name
489
+ * @description Friendly name to show in stream access point listings
490
+ */
491
+ display_name: string;
492
+ /**
493
+ * Tlsftp Server
494
+ * @description URL for the tlsftp server used for tunnel access; must begin with tlsftp and end with a port number
495
+ */
496
+ tlsftp_server: string;
442
497
  };
443
- /** StreamAccessPointDataRelationship */
498
+ /**
499
+ * StreamAccessPointDataRelationship
500
+ * @description Relationship to a stream access point.
501
+ */
444
502
  StreamAccessPointDataRelationship: {
445
- data?: components["schemas"]["StreamAccessPointResourceIdentifier"] | null;
503
+ /** Data */
504
+ data: components["schemas"]["AbstractResourceIdentifier_Literal__StreamAccessPoint___"] | components["schemas"]["AbstractResourceIdentifier_Literal__StreamAccessPoint___"][];
446
505
  };
447
- /** StreamAccessPointListingTopLevel */
448
- StreamAccessPointListingTopLevel: {
506
+ /**
507
+ * StreamAccessPointListResponse
508
+ * @description Top-level response for a list of stream access points.
509
+ */
510
+ StreamAccessPointListResponse: {
449
511
  /** Data */
450
512
  data: components["schemas"]["StreamAccessPointResponseResource"][];
451
- links?: components["schemas"]["JsonAPIPaginationLinks"];
452
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
513
+ links?: components["schemas"]["PaginationLinks"] | null;
514
+ meta: components["schemas"]["TopLevelMeta"];
453
515
  };
454
- /** StreamAccessPointResourceIdentifier */
455
- StreamAccessPointResourceIdentifier: {
456
- /**
457
- * Type
458
- * @default StreamAccessPoint
459
- * @constant
460
- */
461
- type: "StreamAccessPoint";
462
- /**
463
- * Id
464
- * Format: uuid
465
- * @description Unique identifier of the stream access point
466
- */
467
- id: string;
516
+ /**
517
+ * StreamAccessPointResponse
518
+ * @description Top-level response for a single stream access point.
519
+ */
520
+ StreamAccessPointResponse: {
521
+ data: components["schemas"]["StreamAccessPointResponseResource"];
522
+ meta: components["schemas"]["TopLevelMeta"];
468
523
  };
469
- /** StreamAccessPointResponseRelationships */
524
+ /**
525
+ * StreamAccessPointResponseRelationships
526
+ * @description Relationships returned on a stream access point response.
527
+ */
470
528
  StreamAccessPointResponseRelationships: {
471
529
  /** @description Globus Connect Server endpoint that hosts the stream access point */
472
530
  host_endpoint: components["schemas"]["EndpointDataRelationship"];
473
531
  };
474
- /** StreamAccessPointResponseResource */
532
+ /**
533
+ * StreamAccessPointResponseResource
534
+ * @description SAP resource returned in responses.
535
+ */
475
536
  StreamAccessPointResponseResource: {
476
537
  /**
477
538
  * Type
@@ -482,18 +543,35 @@ export interface components {
482
543
  /**
483
544
  * Id
484
545
  * Format: uuid
485
- * @description Unique identifier of the stream access point
486
546
  */
487
547
  id: string;
488
- /** @description Attributes belonging to a stream access point */
489
548
  attributes: components["schemas"]["StreamAccessPointAttributes"];
490
- /** @description Entities related to a stream access point */
491
- relationships: components["schemas"]["StreamAccessPointResponseRelationships"];
549
+ relationships?: components["schemas"]["StreamAccessPointResponseRelationships"] | null;
492
550
  };
493
- /** StreamAccessPointResponseTopLevel */
494
- StreamAccessPointResponseTopLevel: {
495
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
496
- data: components["schemas"]["StreamAccessPointResponseResource"];
551
+ /** TopLevelMeta */
552
+ TopLevelMeta: {
553
+ /** Request Id */
554
+ request_id: string;
555
+ };
556
+ /**
557
+ * TunnelCreateRequest
558
+ * @description Top-level POST request body for tunnel creation.
559
+ */
560
+ TunnelCreateRequest: {
561
+ data: components["schemas"]["TunnelCreateResource"];
562
+ };
563
+ /**
564
+ * TunnelCreateResource
565
+ * @description Tunnel resource for POST request bodies.
566
+ */
567
+ TunnelCreateResource: {
568
+ /**
569
+ * Type
570
+ * @constant
571
+ */
572
+ type: "Tunnel";
573
+ attributes: components["schemas"]["TunnelRequestAttributes"];
574
+ relationships?: components["schemas"]["TunnelRequestRelationships"] | null;
497
575
  };
498
576
  /** TunnelEventAttributes */
499
577
  TunnelEventAttributes: {
@@ -524,18 +602,23 @@ export interface components {
524
602
  */
525
603
  time: string;
526
604
  };
527
- /** TunnelEventListingTopLevel */
528
- TunnelEventListingTopLevel: {
605
+ /**
606
+ * TunnelEventListResponse
607
+ * @description Top-level response for a list of tunnel events.
608
+ */
609
+ TunnelEventListResponse: {
529
610
  /** Data */
530
611
  data: components["schemas"]["TunnelEventResponseResource"][];
531
- links?: components["schemas"]["JsonAPIPaginationLinks"];
532
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
612
+ links?: components["schemas"]["PaginationLinks"] | null;
613
+ meta: components["schemas"]["TopLevelMeta"];
533
614
  };
534
- /** TunnelEventResponseResource */
615
+ /**
616
+ * TunnelEventResponseResource
617
+ * @description Tunnel event resource returned in responses.
618
+ */
535
619
  TunnelEventResponseResource: {
536
620
  /**
537
621
  * Type
538
- * @default TunnelEvent
539
622
  * @constant
540
623
  */
541
624
  type: "TunnelEvent";
@@ -544,17 +627,24 @@ export interface components {
544
627
  * @description Unique identifier of the event
545
628
  */
546
629
  id: number;
547
- /** @description Attributes of the event */
548
- attributes: components["schemas"]["TunnelEventAttributes"] | null;
630
+ attributes: components["schemas"]["TunnelEventAttributes"];
631
+ /** Relationships */
632
+ relationships?: null;
549
633
  };
550
- /** TunnelListingTopLevel */
551
- TunnelListingTopLevel: {
634
+ /**
635
+ * TunnelListResponse
636
+ * @description Top-level response for a list of tunnels.
637
+ */
638
+ TunnelListResponse: {
552
639
  /** Data */
553
640
  data: components["schemas"]["TunnelResponseResource"][];
554
- links?: components["schemas"]["JsonAPIPaginationLinks"];
555
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
641
+ links?: components["schemas"]["PaginationLinks"] | null;
642
+ meta: components["schemas"]["TopLevelMeta"];
556
643
  };
557
- /** TunnelPatchAttributes */
644
+ /**
645
+ * TunnelPatchAttributes
646
+ * @description Attributes settable on a tunnel patch.
647
+ */
558
648
  TunnelPatchAttributes: {
559
649
  /**
560
650
  * Label
@@ -577,22 +667,21 @@ export interface components {
577
667
  */
578
668
  state?: "STOPPING" | null;
579
669
  };
580
- /** TunnelPatchResource */
670
+ /**
671
+ * TunnelPatchResource
672
+ * @description Tunnel resource for PATCH request bodies.
673
+ */
581
674
  TunnelPatchResource: {
582
- /**
583
- * Type
584
- * @default Tunnel
585
- * @constant
586
- */
587
- type: "Tunnel";
588
- /** @description Attributes settable on a tunnel update */
675
+ /** Id */
676
+ id?: string | null;
677
+ /** Type */
678
+ type?: "Tunnel" | null;
589
679
  attributes: components["schemas"]["TunnelPatchAttributes"];
590
680
  };
591
- /** TunnelPatchTopLevel */
592
- TunnelPatchTopLevel: {
593
- data: components["schemas"]["TunnelPatchResource"];
594
- };
595
- /** TunnelRequestAttributes */
681
+ /**
682
+ * TunnelRequestAttributes
683
+ * @description Attributes for tunnel creation.
684
+ */
596
685
  TunnelRequestAttributes: {
597
686
  /**
598
687
  * Label
@@ -628,31 +717,28 @@ export interface components {
628
717
  */
629
718
  restartable: boolean;
630
719
  };
631
- /** TunnelRequestRelationships */
720
+ /**
721
+ * TunnelRequestRelationships
722
+ * @description Relationships settable on tunnel creation.
723
+ */
632
724
  TunnelRequestRelationships: {
633
725
  /** @description Stream access point for listener application */
634
726
  listener: components["schemas"]["StreamAccessPointDataRelationship"];
635
727
  /** @description Stream access point for initiator application */
636
728
  initiator: components["schemas"]["StreamAccessPointDataRelationship"];
637
729
  };
638
- /** TunnelRequestResource */
639
- TunnelRequestResource: {
640
- /**
641
- * Type
642
- * @default Tunnel
643
- * @constant
644
- */
645
- type: "Tunnel";
646
- /** @description Attributes settable on a tunnel request */
647
- attributes: components["schemas"]["TunnelRequestAttributes"];
648
- /** @description Request-settable entities related to a tunnel */
649
- relationships: components["schemas"]["TunnelRequestRelationships"];
650
- };
651
- /** TunnelRequestTopLevel */
652
- TunnelRequestTopLevel: {
653
- data: components["schemas"]["TunnelRequestResource"];
730
+ /**
731
+ * TunnelResponse
732
+ * @description Top-level response for a single tunnel.
733
+ */
734
+ TunnelResponse: {
735
+ data: components["schemas"]["TunnelResponseResource"];
736
+ meta: components["schemas"]["TopLevelMeta"];
654
737
  };
655
- /** TunnelResponseAttributes */
738
+ /**
739
+ * TunnelResponseAttributes
740
+ * @description Attributes returned in tunnel responses. Includes all request fields.
741
+ */
656
742
  TunnelResponseAttributes: {
657
743
  /**
658
744
  * Label
@@ -712,7 +798,10 @@ export interface components {
712
798
  /** Status */
713
799
  readonly status: string;
714
800
  };
715
- /** TunnelResponseRelationships */
801
+ /**
802
+ * TunnelResponseRelationships
803
+ * @description Relationships returned on a tunnel response.
804
+ */
716
805
  TunnelResponseRelationships: {
717
806
  /** @description Stream access point for listener application */
718
807
  listener: components["schemas"]["StreamAccessPointDataRelationship"];
@@ -721,7 +810,10 @@ export interface components {
721
810
  /** @description Globus Auth identity that created the tunnel */
722
811
  owner: components["schemas"]["IdentityDataRelationship"];
723
812
  };
724
- /** TunnelResponseResource */
813
+ /**
814
+ * TunnelResponseResource
815
+ * @description Tunnel resource returned in responses.
816
+ */
725
817
  TunnelResponseResource: {
726
818
  /**
727
819
  * Type
@@ -732,18 +824,17 @@ export interface components {
732
824
  /**
733
825
  * Id
734
826
  * Format: uuid
735
- * @description Unique identifier of the tunnel
736
827
  */
737
828
  id: string;
738
- /** @description Attributes of the tunnel */
739
829
  attributes: components["schemas"]["TunnelResponseAttributes"];
740
- /** @description Entities related to the tunnel */
741
- relationships: components["schemas"]["TunnelResponseRelationships"];
830
+ relationships?: components["schemas"]["TunnelResponseRelationships"] | null;
742
831
  };
743
- /** TunnelResponseTopLevel */
744
- TunnelResponseTopLevel: {
745
- meta: components["schemas"]["JsonApiTopLevelMetaInformation"];
746
- data: components["schemas"]["TunnelResponseResource"];
832
+ /**
833
+ * TunnelUpdateRequest
834
+ * @description Top-level PATCH request body for tunnel update.
835
+ */
836
+ TunnelUpdateRequest: {
837
+ data: components["schemas"]["TunnelPatchResource"];
747
838
  };
748
839
  /** ValidationError */
749
840
  ValidationError: {
@@ -791,7 +882,7 @@ export interface operations {
791
882
  [name: string]: unknown;
792
883
  };
793
884
  content: {
794
- "application/json": components["schemas"]["StreamAccessPointListingTopLevel"];
885
+ "application/json": components["schemas"]["StreamAccessPointListResponse"];
795
886
  };
796
887
  };
797
888
  /** @description Validation Error */
@@ -822,7 +913,7 @@ export interface operations {
822
913
  [name: string]: unknown;
823
914
  };
824
915
  content: {
825
- "application/json": components["schemas"]["StreamAccessPointResponseTopLevel"];
916
+ "application/json": components["schemas"]["StreamAccessPointResponse"];
826
917
  };
827
918
  };
828
919
  /** @description Validation Error */
@@ -851,7 +942,7 @@ export interface operations {
851
942
  [name: string]: unknown;
852
943
  };
853
944
  content: {
854
- "application/json": components["schemas"]["TunnelListingTopLevel"];
945
+ "application/json": components["schemas"]["TunnelListResponse"];
855
946
  };
856
947
  };
857
948
  };
@@ -865,7 +956,7 @@ export interface operations {
865
956
  };
866
957
  requestBody: {
867
958
  content: {
868
- "application/json": components["schemas"]["TunnelRequestTopLevel"];
959
+ "application/json": components["schemas"]["TunnelCreateRequest"];
869
960
  };
870
961
  };
871
962
  responses: {
@@ -875,7 +966,7 @@ export interface operations {
875
966
  [name: string]: unknown;
876
967
  };
877
968
  content: {
878
- "application/json": components["schemas"]["TunnelResponseTopLevel"];
969
+ "application/json": components["schemas"]["TunnelResponse"];
879
970
  };
880
971
  };
881
972
  /** @description Validation Error */
@@ -906,7 +997,7 @@ export interface operations {
906
997
  [name: string]: unknown;
907
998
  };
908
999
  content: {
909
- "application/json": components["schemas"]["TunnelResponseTopLevel"];
1000
+ "application/json": components["schemas"]["TunnelResponse"];
910
1001
  };
911
1002
  };
912
1003
  /** @description Validation Error */
@@ -937,7 +1028,7 @@ export interface operations {
937
1028
  [name: string]: unknown;
938
1029
  };
939
1030
  content: {
940
- "application/json": components["schemas"]["JsonApiAbstractResponseTopLevel"];
1031
+ "application/json": components["schemas"]["MetaDocument"];
941
1032
  };
942
1033
  };
943
1034
  /** @description Validation Error */
@@ -962,7 +1053,7 @@ export interface operations {
962
1053
  };
963
1054
  requestBody: {
964
1055
  content: {
965
- "application/json": components["schemas"]["TunnelPatchTopLevel"];
1056
+ "application/json": components["schemas"]["TunnelUpdateRequest"];
966
1057
  };
967
1058
  };
968
1059
  responses: {
@@ -972,7 +1063,7 @@ export interface operations {
972
1063
  [name: string]: unknown;
973
1064
  };
974
1065
  content: {
975
- "application/json": components["schemas"]["TunnelResponseTopLevel"];
1066
+ "application/json": components["schemas"]["TunnelResponse"];
976
1067
  };
977
1068
  };
978
1069
  /** @description Validation Error */
@@ -1012,7 +1103,7 @@ export interface operations {
1012
1103
  [name: string]: unknown;
1013
1104
  };
1014
1105
  content: {
1015
- "application/json": components["schemas"]["TunnelEventListingTopLevel"];
1106
+ "application/json": components["schemas"]["TunnelEventListResponse"];
1016
1107
  };
1017
1108
  };
1018
1109
  /** @description Validation Error */
@@ -1048,7 +1139,7 @@ export interface operations {
1048
1139
  [name: string]: unknown;
1049
1140
  };
1050
1141
  content: {
1051
- "application/json": components["schemas"]["BookmarkListResponseTopLevel"];
1142
+ "application/json": components["schemas"]["BookmarkListResponse"];
1052
1143
  };
1053
1144
  };
1054
1145
  /** @description Validation Error */
@@ -1071,7 +1162,7 @@ export interface operations {
1071
1162
  };
1072
1163
  requestBody: {
1073
1164
  content: {
1074
- "application/json": components["schemas"]["BookmarkCreateTopLevel"];
1165
+ "application/json": components["schemas"]["BookmarkCreateRequest"];
1075
1166
  };
1076
1167
  };
1077
1168
  responses: {
@@ -1081,7 +1172,7 @@ export interface operations {
1081
1172
  [name: string]: unknown;
1082
1173
  };
1083
1174
  content: {
1084
- "application/json": components["schemas"]["BookmarkResponseTopLevel"];
1175
+ "application/json": components["schemas"]["BookmarkResponse"];
1085
1176
  };
1086
1177
  };
1087
1178
  /** @description Validation Error */
@@ -1115,7 +1206,7 @@ export interface operations {
1115
1206
  [name: string]: unknown;
1116
1207
  };
1117
1208
  content: {
1118
- "application/json": components["schemas"]["BookmarkResponseTopLevel"];
1209
+ "application/json": components["schemas"]["BookmarkResponse"];
1119
1210
  };
1120
1211
  };
1121
1212
  /** @description Validation Error */
@@ -1146,7 +1237,7 @@ export interface operations {
1146
1237
  [name: string]: unknown;
1147
1238
  };
1148
1239
  content: {
1149
- "application/json": components["schemas"]["JsonApiAbstractResponseTopLevel"];
1240
+ "application/json": components["schemas"]["MetaDocument"];
1150
1241
  };
1151
1242
  };
1152
1243
  /** @description Validation Error */
@@ -1171,7 +1262,7 @@ export interface operations {
1171
1262
  };
1172
1263
  requestBody: {
1173
1264
  content: {
1174
- "application/json": components["schemas"]["BookmarkPatchTopLevel"];
1265
+ "application/json": components["schemas"]["BookmarkUpdateRequest"];
1175
1266
  };
1176
1267
  };
1177
1268
  responses: {
@@ -1181,7 +1272,7 @@ export interface operations {
1181
1272
  [name: string]: unknown;
1182
1273
  };
1183
1274
  content: {
1184
- "application/json": components["schemas"]["BookmarkResponseTopLevel"];
1275
+ "application/json": components["schemas"]["BookmarkResponse"];
1185
1276
  };
1186
1277
  };
1187
1278
  /** @description Validation Error */