@globus/sdk 6.0.0-rc.9 → 6.0.1

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 (78) hide show
  1. package/README.md +4 -0
  2. package/dist/cjs/core/authorization/index.js +19 -5
  3. package/dist/cjs/core/authorization/index.js.map +2 -2
  4. package/dist/cjs/core/info/index.js +1 -1
  5. package/dist/cjs/core/info/index.js.map +1 -1
  6. package/dist/cjs/index.js +27 -8
  7. package/dist/cjs/index.js.map +2 -2
  8. package/dist/cjs/services/globus-connect-server/client.js +2 -2
  9. package/dist/cjs/services/globus-connect-server/client.js.map +2 -2
  10. package/dist/esm/core/authorization/AuthorizationManager.d.ts +38 -5
  11. package/dist/esm/core/authorization/AuthorizationManager.d.ts.map +1 -1
  12. package/dist/esm/core/authorization/AuthorizationManager.js +37 -4
  13. package/dist/esm/core/authorization/AuthorizationManager.js.map +1 -1
  14. package/dist/esm/core/authorization/RedirectTransport.d.ts +2 -0
  15. package/dist/esm/core/authorization/RedirectTransport.d.ts.map +1 -1
  16. package/dist/esm/core/authorization/RedirectTransport.js.map +1 -1
  17. package/dist/esm/core/info/version.d.ts +1 -1
  18. package/dist/esm/core/info/version.js +1 -1
  19. package/dist/esm/index.d.ts +24 -2
  20. package/dist/esm/index.d.ts.map +1 -1
  21. package/dist/esm/index.js +24 -2
  22. package/dist/esm/index.js.map +1 -1
  23. package/dist/esm/open-api/types/compute.d.ts +47 -21
  24. package/dist/esm/open-api/types/compute.d.ts.map +1 -1
  25. package/dist/esm/open-api/types/flows.d.ts +507 -424
  26. package/dist/esm/open-api/types/flows.d.ts.map +1 -1
  27. package/dist/esm/open-api/types/flows.js +0 -4
  28. package/dist/esm/open-api/types/flows.js.map +1 -1
  29. package/dist/esm/open-api/types/gcs/v5.4.d.ts +1348 -1036
  30. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
  31. package/dist/esm/open-api/types/search.d.ts +91 -7
  32. package/dist/esm/open-api/types/search.d.ts.map +1 -1
  33. package/dist/esm/open-api/types/timers.d.ts +263 -17
  34. package/dist/esm/open-api/types/timers.d.ts.map +1 -1
  35. package/dist/esm/package.json +1 -1
  36. package/dist/esm/services/flows/service/flows.d.ts +9 -8
  37. package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
  38. package/dist/esm/services/flows/service/flows.js.map +1 -1
  39. package/dist/esm/services/flows/service/runs.d.ts +17 -24
  40. package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
  41. package/dist/esm/services/flows/service/runs.js.map +1 -1
  42. package/dist/esm/services/globus-connect-server/client.d.ts +55 -0
  43. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  44. package/dist/esm/services/shared.js +1 -1
  45. package/dist/esm/services/shared.js.map +1 -1
  46. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +3 -3
  47. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
  48. package/dist/esm/services/transfer/service/endpoint.d.ts +1 -0
  49. package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
  50. package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
  51. package/dist/esm/services/transfer/service/task.d.ts +3 -3
  52. package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
  53. package/dist/esm/services/transfer/types.d.ts +1 -1
  54. package/dist/esm/services/transfer/types.d.ts.map +1 -1
  55. package/dist/esm/services/transfer/utils.d.ts.map +1 -1
  56. package/dist/esm/services/transfer/utils.js +8 -3
  57. package/dist/esm/services/transfer/utils.js.map +1 -1
  58. package/dist/esm/services/types.d.ts +4 -0
  59. package/dist/esm/services/types.d.ts.map +1 -1
  60. package/dist/umd/globus.production.js +2 -2
  61. package/dist/umd/globus.production.js.map +2 -2
  62. package/package.json +4 -4
  63. package/dist/esm/open-api/types/timer.d.ts +0 -942
  64. package/dist/esm/open-api/types/timer.d.ts.map +0 -1
  65. package/dist/esm/open-api/types/timer.js +0 -2
  66. package/dist/esm/open-api/types/timer.js.map +0 -1
  67. package/dist/esm/services/timer/config.d.ts +0 -4
  68. package/dist/esm/services/timer/config.d.ts.map +0 -1
  69. package/dist/esm/services/timer/config.js +0 -10
  70. package/dist/esm/services/timer/config.js.map +0 -1
  71. package/dist/esm/services/timer/index.d.ts +0 -16
  72. package/dist/esm/services/timer/index.d.ts.map +0 -1
  73. package/dist/esm/services/timer/index.js +0 -15
  74. package/dist/esm/services/timer/index.js.map +0 -1
  75. package/dist/esm/services/timer/service/timer.d.ts +0 -32
  76. package/dist/esm/services/timer/service/timer.d.ts.map +0 -1
  77. package/dist/esm/services/timer/service/timer.js +0 -11
  78. package/dist/esm/services/timer/service/timer.js.map +0 -1
@@ -221,16 +221,16 @@ export interface paths {
221
221
  * @description Delete the custom collection domain.
222
222
  *
223
223
  * If this is a mapped collection, this will cause the collection to revert to
224
- * a subdomain of the endpoint's domain (if it is wildcard domain) or a
225
- * subdomain of the endpoint's data.globus.org domain. If this mapped collection
224
+ * a subdomain of the endpoint's default domain issued at creation time or
225
+ * the endpoint's custom wildcard domain if it has one. If this mapped collection
226
226
  * has a wildcard domain when this is called, then all guest collections without
227
227
  * custom domains will have their domains changed as well.
228
228
  *
229
229
  * If this is a guest collection, and the mapped collection it was created from
230
230
  * has a custom wildcard domain, then this collection will become a subdomain
231
- * of that domain; otherwise it will revert to a subdomain of either the
232
- * endpoint's domain (if it is a wildcard domain) or a subdomain of the endpoint's
233
- * data.globus.org domain.
231
+ * of that domain; otherwise it will revert to a subdomain of the
232
+ * endpoint's default domain issued at creation time or the endpoint's
233
+ * custom wildcard domain if it has one.
234
234
  *
235
235
  * This requires an `administrator` role on the Endpoint.
236
236
  *
@@ -451,9 +451,9 @@ export interface paths {
451
451
  /**
452
452
  * Delete endpoint domain
453
453
  * @description Delete the custom endpoint domain. This will cause the endpoint
454
- * to revert to using a data.globus.org domain for the GCS Manager
455
- * and any collections which do not have custom domains associated
456
- * with them.
454
+ * to revert to using the default domain issued at creation time
455
+ * for the GCS Manager and any collections which do not have custom
456
+ * domains associated with them.
457
457
  *
458
458
  * This requires an `administrator` role on the Endpoint.
459
459
  *
@@ -1143,13 +1143,12 @@ export interface components {
1143
1143
  * @enum {string}
1144
1144
  */
1145
1145
  DATA_TYPE: "authentication_timeout#1.0.0";
1146
- /** @description Boolean flag indicating whether the new authentication
1147
- * must be done within the same auth session as the
1148
- * application making the request.
1149
- * */
1146
+ /** @description Boolean flag indicating whether the new authentication must be done
1147
+ * within the same auth session as the application making the request.
1148
+ * */
1150
1149
  high_assurance?: boolean;
1151
- /** @description List of identities that would have otherwise been
1152
- * authorized except that the authentication has timed out.
1150
+ /** @description List of identities that would have otherwise been authorized except
1151
+ * that the authentication has timed out.
1153
1152
  * */
1154
1153
  identities?: string[];
1155
1154
  };
@@ -1168,17 +1167,16 @@ export interface components {
1168
1167
  * @enum {string}
1169
1168
  */
1170
1169
  DATA_TYPE: "authentication_timeout#1.1.0";
1171
- /** @description Boolean flag indicating whether the new authentication
1172
- * must be done within the same auth session as the
1173
- * application making the request.
1174
- * */
1170
+ /** @description Boolean flag indicating whether the new authentication must be done
1171
+ * within the same auth session as the application making the request.
1172
+ * */
1175
1173
  high_assurance?: boolean;
1176
- /** @description List of identities that would have otherwise been
1177
- * authorized except that the authentication has timed out.
1174
+ /** @description List of identities that would have otherwise been authorized except
1175
+ * that the authentication has timed out.
1178
1176
  * */
1179
1177
  identities?: string[];
1180
- /** @description Flag indicating that multi-factor authentication is required.
1181
- * Only occurs on high assurance storage gateways.
1178
+ /** @description Flag indicating that multi-factor authentication is required. Only
1179
+ * occurs on high assurance storage gateways.
1182
1180
  * */
1183
1181
  require_mfa?: boolean;
1184
1182
  };
@@ -1218,36 +1216,36 @@ export interface components {
1218
1216
  /** @description PEM-Encoded X.509 certificate for this domain */
1219
1217
  certificate?: string | null;
1220
1218
  /** @description PEM-Encoded X.509 certificate chain for this domain. Only needed if
1221
- * there are intermediate certificates that must also be sent to
1222
- * clients to allow them to verify the certificate.
1219
+ * there are intermediate certificates that must also be sent to clients
1220
+ * to allow them to verify the certificate.
1223
1221
  * */
1224
1222
  certificate_chain?: string | null;
1225
- /** @description Path to a file containing the X.509 certificate chain for this
1226
- * domain. This file path must contain a sequence of valid
1227
- * certificate and be present on each data transfer node.
1223
+ /** @description Path to a file containing the X.509 certificate chain for this domain.
1224
+ * This file path must contain a sequence of valid certificate and be
1225
+ * present on each data transfer node.
1228
1226
  * */
1229
1227
  certificate_chain_path?: string | null;
1230
- /** @description Path to a file containing the X.509 certificate for this domain.
1231
- * This file path must contain a valid certificate and be present on
1232
- * each data transfer node.
1228
+ /** @description Path to a file containing the X.509 certificate for this domain. This
1229
+ * file path must contain a valid certificate and be present on each data
1230
+ * transfer node.
1233
1231
  * */
1234
1232
  certificate_path?: string | null;
1235
1233
  /** @description Domain name */
1236
1234
  domain_name: string;
1237
1235
  /** @description PEM-Encoded private key for the certificate */
1238
1236
  private_key?: string | null;
1239
- /** @description Path to a file containing the private key for this domain. This
1240
- * file path must contain a valid key and be present on each data
1241
- * transfer node.
1237
+ /** @description Path to a file containing the private key for this domain. This file
1238
+ * path must contain a valid key and be present on each data transfer
1239
+ * node.
1242
1240
  * */
1243
1241
  private_key_path?: string | null;
1244
1242
  /** @description Flag indicating whether this is a wildcard domain or not.
1245
1243
  *
1246
- * When setting a custom domain for a mapped collection, the domain
1247
- * may optionally be a wildcard domain. If it is a wildcard domain,
1248
- * the guest collections will be created as subdomains of the mapped
1249
- * collection domain; if not, guest collections will be created as
1250
- * subdomains of the endpoint domain.
1244
+ * When setting a custom domain for a mapped collection, the domain may
1245
+ * optionally be a wildcard domain. If it is a wildcard domain, the guest
1246
+ * collections will be created as subdomains of the mapped collection
1247
+ * domain; if not, guest collections will be created as subdomains of the
1248
+ * endpoint domain.
1251
1249
  * */
1252
1250
  wildcard: boolean;
1253
1251
  };
@@ -1440,9 +1438,9 @@ export interface components {
1440
1438
  * @description Unique id for this sharing policy
1441
1439
  */
1442
1440
  id?: string;
1443
- /** @description Restrictions on which paths may be shared in guest collections
1444
- * related to this mapped collection. These paths are relative to the
1445
- * root_path property of the mapped collection.
1441
+ /** @description Restrictions on which paths may be shared in guest collections related
1442
+ * to this mapped collection. These paths are relative to the root_path
1443
+ * property of the mapped collection.
1446
1444
  * */
1447
1445
  sharing_restrict_paths: components["schemas"]["PathRestrictions"];
1448
1446
  /** @description List of local user accounts that this policy applies to. If omitted
@@ -1467,33 +1465,32 @@ export interface components {
1467
1465
  */
1468
1466
  DATA_TYPE: "collection#1.0.0";
1469
1467
  /** @description Flag indicating if this Collection allows users to create guest
1470
- * collections on it. This is always false if this is a guest
1471
- * collection. If this is changed to false on a mapped collection with
1472
- * associated guest collections, those collections will no longer be
1473
- * accessible.
1468
+ * collections on it. This is always false if this is a guest collection.
1469
+ * If this is changed to false on a mapped collection with associated
1470
+ * guest collections, those collections will no longer be accessible.
1474
1471
  * */
1475
1472
  allow_guest_collections?: boolean;
1476
1473
  /** @description Timeout (in minutes) during which a user is required to have
1477
1474
  * authenticated in a session to access this storage gateway.
1478
1475
  * */
1479
1476
  readonly authentication_timeout_mins?: number;
1480
- /** @description Path to be interpreted as the base path when creating a new
1481
- * collection. It is interpreted differently depending on the
1482
- * collection type being created. For a mapped collection, this is an
1483
- * absolute path on the storage system named by the
1484
- * storage_gateway_id. For a guest collection, this is a relative
1485
- * path relative to the value of the `root_path` attribute on the
1486
- * mapped collection with the same Id as the `mapped_collection_id`
1487
- * property. This may not be changed once the collection is created.
1477
+ /** @description Path to be interpreted as the base path when creating a new collection.
1478
+ * It is interpreted differently depending on the collection type being
1479
+ * created. For a mapped collection, this is an absolute path on the
1480
+ * storage system named by the storage_gateway_id. For a guest collection,
1481
+ * this is a relative path relative to the value of the `root_path`
1482
+ * attribute on the mapped collection with the same Id as the
1483
+ * `mapped_collection_id` property. This may not be changed once the
1484
+ * collection is created.
1488
1485
  *
1489
1486
  * Support for `~` was added in API version 1.21.0.
1490
1487
  * */
1491
1488
  collection_base_path: string;
1492
1489
  /**
1493
- * @description Type of collection. A `mapped` collection requires an account on
1494
- * the system to access the administrator-defined collection. A
1495
- * `guest` collection allows users to share access to their data on a
1496
- * Storage Gateway by registering a credential with the GCS Manager.
1490
+ * @description Type of collection. A `mapped` collection requires an account on the
1491
+ * system to access the administrator-defined collection. A `guest`
1492
+ * collection allows users to share access to their data on a Storage
1493
+ * Gateway by registering a credential with the GCS Manager.
1497
1494
  *
1498
1495
  * @enum {string}
1499
1496
  */
@@ -1503,30 +1500,29 @@ export interface components {
1503
1500
  * @description Id of the connector type that is used by this collection.
1504
1501
  */
1505
1502
  readonly connector_id?: string;
1506
- /** @description Email address of the support contact for this collection. This is visible
1507
- * to end users so that they may contact your organization for support.
1503
+ /** @description Email address of the support contact for this collection. This is
1504
+ * visible to end users so that they may contact your organization for
1505
+ * support.
1508
1506
  * */
1509
1507
  contact_email?: string | null;
1510
- /** @description Other non-email contact information for the collection, e.g. phone and
1511
- * mailing address. This is visible to end users for support.
1508
+ /** @description Other non-email contact information for the collection, e.g. phone
1509
+ * and mailing address. This is visible to end users for support.
1512
1510
  * */
1513
1511
  contact_info?: string | null;
1514
1512
  /** @description Default directory when accessing the collection. This may include
1515
1513
  * the special string `$USER` which is evaluated at access time to be
1516
1514
  * the connector-specific username accessing the data.
1517
1515
  *
1518
- * If the collection is mapped collection with a
1519
- * **collection_base_path** value of `/`, this value can also begin
1520
- * with the values `/~/` and `$HOME`, which are replaced by the user's
1521
- * home directory, or `/` if the connector does not support the
1522
- * concept of a home directory.
1516
+ * If the collection is mapped collection with a **collection_base_path**
1517
+ * value of `/`, this value can also begin with the values `/~/` and
1518
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
1519
+ * the connector does not support the concept of a home directory.
1523
1520
  * */
1524
1521
  default_directory?: string;
1525
1522
  /** @description Flag indicating that this collection has been deleted */
1526
1523
  readonly deleted?: boolean;
1527
- /** @description Department within organization that runs the server(s).
1528
- * Searchable. Optional. Unicode string, max 1024
1529
- * characters, no new lines.
1524
+ /** @description Department within organization that runs the server(s). Searchable.
1525
+ * Optional. Unicode string, max 1024 characters, no new lines.
1530
1526
  * */
1531
1527
  department?: string | null;
1532
1528
  /** @description A description of the collection. */
@@ -1535,14 +1531,14 @@ export interface components {
1535
1531
  * checksums, needed for the verify_checksum option of transfer.
1536
1532
  * */
1537
1533
  disable_verify?: boolean;
1538
- /** @description Friendly name for the collection. Unicode string, max 128
1539
- * characters, no new lines (`\r` or `\n`).
1534
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
1535
+ * no new lines (`\r` or `\n`).
1540
1536
  * */
1541
1537
  display_name: string;
1542
1538
  /** @description DNS name of the virtual host serving this collection. For mapped
1543
- * collections which do not have a custom domain, this may be specified as
1544
- * part of the input document to create the collection, otherwise this is
1545
- * a read-only property. When included in the input, the name is
1539
+ * collections which do not have a custom domain, this may be specified
1540
+ * as part of the input document to create the collection, otherwise this
1541
+ * is a read-only property. When included in the input, the name is
1546
1542
  * restricted to be a subdomain of the endpoint, and the input name label
1547
1543
  * may not start with `m-` or `g-`.
1548
1544
  * */
@@ -1552,8 +1548,7 @@ export interface components {
1552
1548
  *
1553
1549
  * __New in v5.4.17__: If a mapped collection forces encryption, all
1554
1550
  * of its guest collections must as well. If this option is used on a
1555
- * mapped collection, the value is propagated to its guest
1556
- * collections.
1551
+ * mapped collection, the value is propagated to its guest collections.
1557
1552
  * */
1558
1553
  force_encryption?: boolean;
1559
1554
  /** @description Flag indicating if this collection is created on a high assurance
@@ -1564,8 +1559,8 @@ export interface components {
1564
1559
  readonly https_url?: string;
1565
1560
  /**
1566
1561
  * Format: uuid
1567
- * @description Unique identifier for this collection. This is assigned
1568
- * by the GCS manager when creating a collection.
1562
+ * @description Unique identifier for this collection. This is assigned by the GCS
1563
+ * manager when creating a collection.
1569
1564
  *
1570
1565
  */
1571
1566
  readonly id?: string;
@@ -1578,9 +1573,8 @@ export interface components {
1578
1573
  identity_id?: string;
1579
1574
  /** @description Link to a web page with more information about the collection */
1580
1575
  info_link?: string | null;
1581
- /** @description List of search keywords for the
1582
- * endpoint. Optional. Unicode string, max 1024
1583
- * characters total across all strings.
1576
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
1577
+ * max 1024 characters total across all strings.
1584
1578
  * */
1585
1579
  keywords?: string[];
1586
1580
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -1664,33 +1658,32 @@ export interface components {
1664
1658
  */
1665
1659
  DATA_TYPE: "collection#1.1.0";
1666
1660
  /** @description Flag indicating if this Collection allows users to create guest
1667
- * collections on it. This is always false if this is a guest
1668
- * collection. If this is changed to false on a mapped collection with
1669
- * associated guest collections, those collections will no longer be
1670
- * accessible.
1661
+ * collections on it. This is always false if this is a guest collection.
1662
+ * If this is changed to false on a mapped collection with associated
1663
+ * guest collections, those collections will no longer be accessible.
1671
1664
  * */
1672
1665
  allow_guest_collections?: boolean;
1673
1666
  /** @description Timeout (in minutes) during which a user is required to have
1674
1667
  * authenticated in a session to access this storage gateway.
1675
1668
  * */
1676
1669
  readonly authentication_timeout_mins?: number;
1677
- /** @description Path to be interpreted as the base path when creating a new
1678
- * collection. It is interpreted differently depending on the
1679
- * collection type being created. For a mapped collection, this is an
1680
- * absolute path on the storage system named by the
1681
- * storage_gateway_id. For a guest collection, this is a relative
1682
- * path relative to the value of the `root_path` attribute on the
1683
- * mapped collection with the same Id as the `mapped_collection_id`
1684
- * property. This may not be changed once the collection is created.
1670
+ /** @description Path to be interpreted as the base path when creating a new collection.
1671
+ * It is interpreted differently depending on the collection type being
1672
+ * created. For a mapped collection, this is an absolute path on the
1673
+ * storage system named by the storage_gateway_id. For a guest collection,
1674
+ * this is a relative path relative to the value of the `root_path`
1675
+ * attribute on the mapped collection with the same Id as the
1676
+ * `mapped_collection_id` property. This may not be changed once the
1677
+ * collection is created.
1685
1678
  *
1686
1679
  * Support for `~` was added in API version 1.21.0.
1687
1680
  * */
1688
1681
  collection_base_path: string;
1689
1682
  /**
1690
- * @description Type of collection. A `mapped` collection requires an account on
1691
- * the system to access the administrator-defined collection. A
1692
- * `guest` collection allows users to share access to their data on a
1693
- * Storage Gateway by registering a credential with the GCS Manager.
1683
+ * @description Type of collection. A `mapped` collection requires an account on the
1684
+ * system to access the administrator-defined collection. A `guest`
1685
+ * collection allows users to share access to their data on a Storage
1686
+ * Gateway by registering a credential with the GCS Manager.
1694
1687
  *
1695
1688
  * @enum {string}
1696
1689
  */
@@ -1700,30 +1693,29 @@ export interface components {
1700
1693
  * @description Id of the connector type that is used by this collection.
1701
1694
  */
1702
1695
  readonly connector_id?: string;
1703
- /** @description Email address of the support contact for this collection. This is visible
1704
- * to end users so that they may contact your organization for support.
1696
+ /** @description Email address of the support contact for this collection. This is
1697
+ * visible to end users so that they may contact your organization for
1698
+ * support.
1705
1699
  * */
1706
1700
  contact_email?: string | null;
1707
- /** @description Other non-email contact information for the collection, e.g. phone and
1708
- * mailing address. This is visible to end users for support.
1701
+ /** @description Other non-email contact information for the collection, e.g. phone
1702
+ * and mailing address. This is visible to end users for support.
1709
1703
  * */
1710
1704
  contact_info?: string | null;
1711
1705
  /** @description Default directory when accessing the collection. This may include
1712
1706
  * the special string `$USER` which is evaluated at access time to be
1713
1707
  * the connector-specific username accessing the data.
1714
1708
  *
1715
- * If the collection is mapped collection with a
1716
- * **collection_base_path** value of `/`, this value can also begin
1717
- * with the values `/~/` and `$HOME`, which are replaced by the user's
1718
- * home directory, or `/` if the connector does not support the
1719
- * concept of a home directory.
1709
+ * If the collection is mapped collection with a **collection_base_path**
1710
+ * value of `/`, this value can also begin with the values `/~/` and
1711
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
1712
+ * the connector does not support the concept of a home directory.
1720
1713
  * */
1721
1714
  default_directory?: string;
1722
1715
  /** @description Flag indicating that this collection has been deleted */
1723
1716
  readonly deleted?: boolean;
1724
- /** @description Department within organization that runs the server(s).
1725
- * Searchable. Optional. Unicode string, max 1024
1726
- * characters, no new lines.
1717
+ /** @description Department within organization that runs the server(s). Searchable.
1718
+ * Optional. Unicode string, max 1024 characters, no new lines.
1727
1719
  * */
1728
1720
  department?: string | null;
1729
1721
  /** @description A description of the collection. */
@@ -1732,14 +1724,14 @@ export interface components {
1732
1724
  * checksums, needed for the verify_checksum option of transfer.
1733
1725
  * */
1734
1726
  disable_verify?: boolean;
1735
- /** @description Friendly name for the collection. Unicode string, max 128
1736
- * characters, no new lines (`\r` or `\n`).
1727
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
1728
+ * no new lines (`\r` or `\n`).
1737
1729
  * */
1738
1730
  display_name: string;
1739
1731
  /** @description DNS name of the virtual host serving this collection. For mapped
1740
- * collections which do not have a custom domain, this may be specified as
1741
- * part of the input document to create the collection, otherwise this is
1742
- * a read-only property. When included in the input, the name is
1732
+ * collections which do not have a custom domain, this may be specified
1733
+ * as part of the input document to create the collection, otherwise this
1734
+ * is a read-only property. When included in the input, the name is
1743
1735
  * restricted to be a subdomain of the endpoint, and the input name label
1744
1736
  * may not start with `m-` or `g-`.
1745
1737
  * */
@@ -1755,8 +1747,7 @@ export interface components {
1755
1747
  *
1756
1748
  * __New in v5.4.17__: If a mapped collection forces encryption, all
1757
1749
  * of its guest collections must as well. If this option is used on a
1758
- * mapped collection, the value is propagated to its guest
1759
- * collections.
1750
+ * mapped collection, the value is propagated to its guest collections.
1760
1751
  * */
1761
1752
  force_encryption?: boolean;
1762
1753
  /** @description Flag indicating if this collection is created on a high assurance
@@ -1767,8 +1758,8 @@ export interface components {
1767
1758
  readonly https_url?: string;
1768
1759
  /**
1769
1760
  * Format: uuid
1770
- * @description Unique identifier for this collection. This is assigned
1771
- * by the GCS manager when creating a collection.
1761
+ * @description Unique identifier for this collection. This is assigned by the GCS
1762
+ * manager when creating a collection.
1772
1763
  *
1773
1764
  */
1774
1765
  readonly id?: string;
@@ -1781,9 +1772,8 @@ export interface components {
1781
1772
  identity_id?: string;
1782
1773
  /** @description Link to a web page with more information about the collection */
1783
1774
  info_link?: string | null;
1784
- /** @description List of search keywords for the
1785
- * endpoint. Optional. Unicode string, max 1024
1786
- * characters total across all strings.
1775
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
1776
+ * max 1024 characters total across all strings.
1787
1777
  * */
1788
1778
  keywords?: string[];
1789
1779
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -1850,11 +1840,10 @@ export interface components {
1850
1840
  * message may be up to 64 characters long.
1851
1841
  * */
1852
1842
  user_message?: string | null;
1853
- /** @description Link to additional messaging for clients to display to users
1854
- * when interacting with this endpoint, linked to an
1855
- * HTTP or HTTPS URL. For guest collections, this property is
1856
- * read-only and is the same as the value of its related mapped
1857
- * collection.
1843
+ /** @description Link to additional messaging for clients to display to users when
1844
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
1845
+ * guest collections, this property is read-only and is the same as the
1846
+ * value of its related mapped collection.
1858
1847
  * */
1859
1848
  user_message_link?: string | null;
1860
1849
  };
@@ -1883,33 +1872,32 @@ export interface components {
1883
1872
  */
1884
1873
  DATA_TYPE: "collection#1.2.0";
1885
1874
  /** @description Flag indicating if this Collection allows users to create guest
1886
- * collections on it. This is always false if this is a guest
1887
- * collection. If this is changed to false on a mapped collection with
1888
- * associated guest collections, those collections will no longer be
1889
- * accessible.
1875
+ * collections on it. This is always false if this is a guest collection.
1876
+ * If this is changed to false on a mapped collection with associated
1877
+ * guest collections, those collections will no longer be accessible.
1890
1878
  * */
1891
1879
  allow_guest_collections?: boolean;
1892
1880
  /** @description Timeout (in minutes) during which a user is required to have
1893
1881
  * authenticated in a session to access this storage gateway.
1894
1882
  * */
1895
1883
  readonly authentication_timeout_mins?: number;
1896
- /** @description Path to be interpreted as the base path when creating a new
1897
- * collection. It is interpreted differently depending on the
1898
- * collection type being created. For a mapped collection, this is an
1899
- * absolute path on the storage system named by the
1900
- * storage_gateway_id. For a guest collection, this is a relative
1901
- * path relative to the value of the `root_path` attribute on the
1902
- * mapped collection with the same Id as the `mapped_collection_id`
1903
- * property. This may not be changed once the collection is created.
1884
+ /** @description Path to be interpreted as the base path when creating a new collection.
1885
+ * It is interpreted differently depending on the collection type being
1886
+ * created. For a mapped collection, this is an absolute path on the
1887
+ * storage system named by the storage_gateway_id. For a guest collection,
1888
+ * this is a relative path relative to the value of the `root_path`
1889
+ * attribute on the mapped collection with the same Id as the
1890
+ * `mapped_collection_id` property. This may not be changed once the
1891
+ * collection is created.
1904
1892
  *
1905
1893
  * Support for `~` was added in API version 1.21.0.
1906
1894
  * */
1907
1895
  collection_base_path: string;
1908
1896
  /**
1909
- * @description Type of collection. A `mapped` collection requires an account on
1910
- * the system to access the administrator-defined collection. A
1911
- * `guest` collection allows users to share access to their data on a
1912
- * Storage Gateway by registering a credential with the GCS Manager.
1897
+ * @description Type of collection. A `mapped` collection requires an account on the
1898
+ * system to access the administrator-defined collection. A `guest`
1899
+ * collection allows users to share access to their data on a Storage
1900
+ * Gateway by registering a credential with the GCS Manager.
1913
1901
  *
1914
1902
  * @enum {string}
1915
1903
  */
@@ -1919,30 +1907,29 @@ export interface components {
1919
1907
  * @description Id of the connector type that is used by this collection.
1920
1908
  */
1921
1909
  readonly connector_id?: string;
1922
- /** @description Email address of the support contact for this collection. This is visible
1923
- * to end users so that they may contact your organization for support.
1910
+ /** @description Email address of the support contact for this collection. This is
1911
+ * visible to end users so that they may contact your organization for
1912
+ * support.
1924
1913
  * */
1925
1914
  contact_email?: string | null;
1926
- /** @description Other non-email contact information for the collection, e.g. phone and
1927
- * mailing address. This is visible to end users for support.
1915
+ /** @description Other non-email contact information for the collection, e.g. phone
1916
+ * and mailing address. This is visible to end users for support.
1928
1917
  * */
1929
1918
  contact_info?: string | null;
1930
1919
  /** @description Default directory when accessing the collection. This may include
1931
1920
  * the special string `$USER` which is evaluated at access time to be
1932
1921
  * the connector-specific username accessing the data.
1933
1922
  *
1934
- * If the collection is mapped collection with a
1935
- * **collection_base_path** value of `/`, this value can also begin
1936
- * with the values `/~/` and `$HOME`, which are replaced by the user's
1937
- * home directory, or `/` if the connector does not support the
1938
- * concept of a home directory.
1923
+ * If the collection is mapped collection with a **collection_base_path**
1924
+ * value of `/`, this value can also begin with the values `/~/` and
1925
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
1926
+ * the connector does not support the concept of a home directory.
1939
1927
  * */
1940
1928
  default_directory?: string;
1941
1929
  /** @description Flag indicating that this collection has been deleted */
1942
1930
  readonly deleted?: boolean;
1943
- /** @description Department within organization that runs the server(s).
1944
- * Searchable. Optional. Unicode string, max 1024
1945
- * characters, no new lines.
1931
+ /** @description Department within organization that runs the server(s). Searchable.
1932
+ * Optional. Unicode string, max 1024 characters, no new lines.
1946
1933
  * */
1947
1934
  department?: string | null;
1948
1935
  /** @description A description of the collection. */
@@ -1951,14 +1938,14 @@ export interface components {
1951
1938
  * checksums, needed for the verify_checksum option of transfer.
1952
1939
  * */
1953
1940
  disable_verify?: boolean;
1954
- /** @description Friendly name for the collection. Unicode string, max 128
1955
- * characters, no new lines (`\r` or `\n`).
1941
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
1942
+ * no new lines (`\r` or `\n`).
1956
1943
  * */
1957
1944
  display_name: string;
1958
1945
  /** @description DNS name of the virtual host serving this collection. For mapped
1959
- * collections which do not have a custom domain, this may be specified as
1960
- * part of the input document to create the collection, otherwise this is
1961
- * a read-only property. When included in the input, the name is
1946
+ * collections which do not have a custom domain, this may be specified
1947
+ * as part of the input document to create the collection, otherwise this
1948
+ * is a read-only property. When included in the input, the name is
1962
1949
  * restricted to be a subdomain of the endpoint, and the input name label
1963
1950
  * may not start with `m-` or `g-`.
1964
1951
  * */
@@ -1974,8 +1961,7 @@ export interface components {
1974
1961
  *
1975
1962
  * __New in v5.4.17__: If a mapped collection forces encryption, all
1976
1963
  * of its guest collections must as well. If this option is used on a
1977
- * mapped collection, the value is propagated to its guest
1978
- * collections.
1964
+ * mapped collection, the value is propagated to its guest collections.
1979
1965
  * */
1980
1966
  force_encryption?: boolean;
1981
1967
  /** @description Flag indicating if this collection is created on a high assurance
@@ -1986,8 +1972,8 @@ export interface components {
1986
1972
  readonly https_url?: string;
1987
1973
  /**
1988
1974
  * Format: uuid
1989
- * @description Unique identifier for this collection. This is assigned
1990
- * by the GCS manager when creating a collection.
1975
+ * @description Unique identifier for this collection. This is assigned by the GCS
1976
+ * manager when creating a collection.
1991
1977
  *
1992
1978
  */
1993
1979
  readonly id?: string;
@@ -2000,9 +1986,8 @@ export interface components {
2000
1986
  identity_id?: string;
2001
1987
  /** @description Link to a web page with more information about the collection */
2002
1988
  info_link?: string | null;
2003
- /** @description List of search keywords for the
2004
- * endpoint. Optional. Unicode string, max 1024
2005
- * characters total across all strings.
1989
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
1990
+ * max 1024 characters total across all strings.
2006
1991
  * */
2007
1992
  keywords?: string[];
2008
1993
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -2049,8 +2034,8 @@ export interface components {
2049
2034
  * collections on this mapped collection.
2050
2035
  * */
2051
2036
  sharing_users_allow?: string[] | null;
2052
- /** @description List of connector-specific usernames denied access to
2053
- * create new guest collections on this mapped collection.
2037
+ /** @description List of connector-specific usernames denied access to create new guest
2038
+ * collections on this mapped collection.
2054
2039
  * */
2055
2040
  sharing_users_deny?: string[] | null;
2056
2041
  /**
@@ -2077,11 +2062,10 @@ export interface components {
2077
2062
  * message may be up to 64 characters long.
2078
2063
  * */
2079
2064
  user_message?: string | null;
2080
- /** @description Link to additional messaging for clients to display to users
2081
- * when interacting with this endpoint, linked to an
2082
- * HTTP or HTTPS URL. For guest collections, this property is
2083
- * read-only and is the same as the value of its related mapped
2084
- * collection.
2065
+ /** @description Link to additional messaging for clients to display to users when
2066
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
2067
+ * guest collections, this property is read-only and is the same as the
2068
+ * value of its related mapped collection.
2085
2069
  * */
2086
2070
  user_message_link?: string | null;
2087
2071
  };
@@ -2118,33 +2102,32 @@ export interface components {
2118
2102
  */
2119
2103
  DATA_TYPE: "collection#1.3.0";
2120
2104
  /** @description Flag indicating if this Collection allows users to create guest
2121
- * collections on it. This is always false if this is a guest
2122
- * collection. If this is changed to false on a mapped collection with
2123
- * associated guest collections, those collections will no longer be
2124
- * accessible.
2105
+ * collections on it. This is always false if this is a guest collection.
2106
+ * If this is changed to false on a mapped collection with associated
2107
+ * guest collections, those collections will no longer be accessible.
2125
2108
  * */
2126
2109
  allow_guest_collections?: boolean;
2127
2110
  /** @description Timeout (in minutes) during which a user is required to have
2128
2111
  * authenticated in a session to access this storage gateway.
2129
2112
  * */
2130
2113
  readonly authentication_timeout_mins?: number;
2131
- /** @description Path to be interpreted as the base path when creating a new
2132
- * collection. It is interpreted differently depending on the
2133
- * collection type being created. For a mapped collection, this is an
2134
- * absolute path on the storage system named by the
2135
- * storage_gateway_id. For a guest collection, this is a relative
2136
- * path relative to the value of the `root_path` attribute on the
2137
- * mapped collection with the same Id as the `mapped_collection_id`
2138
- * property. This may not be changed once the collection is created.
2114
+ /** @description Path to be interpreted as the base path when creating a new collection.
2115
+ * It is interpreted differently depending on the collection type being
2116
+ * created. For a mapped collection, this is an absolute path on the
2117
+ * storage system named by the storage_gateway_id. For a guest collection,
2118
+ * this is a relative path relative to the value of the `root_path`
2119
+ * attribute on the mapped collection with the same Id as the
2120
+ * `mapped_collection_id` property. This may not be changed once the
2121
+ * collection is created.
2139
2122
  *
2140
2123
  * Support for `~` was added in API version 1.21.0.
2141
2124
  * */
2142
2125
  collection_base_path: string;
2143
2126
  /**
2144
- * @description Type of collection. A `mapped` collection requires an account on
2145
- * the system to access the administrator-defined collection. A
2146
- * `guest` collection allows users to share access to their data on a
2147
- * Storage Gateway by registering a credential with the GCS Manager.
2127
+ * @description Type of collection. A `mapped` collection requires an account on the
2128
+ * system to access the administrator-defined collection. A `guest`
2129
+ * collection allows users to share access to their data on a Storage
2130
+ * Gateway by registering a credential with the GCS Manager.
2148
2131
  *
2149
2132
  * @enum {string}
2150
2133
  */
@@ -2154,30 +2137,29 @@ export interface components {
2154
2137
  * @description Id of the connector type that is used by this collection.
2155
2138
  */
2156
2139
  readonly connector_id?: string;
2157
- /** @description Email address of the support contact for this collection. This is visible
2158
- * to end users so that they may contact your organization for support.
2140
+ /** @description Email address of the support contact for this collection. This is
2141
+ * visible to end users so that they may contact your organization for
2142
+ * support.
2159
2143
  * */
2160
2144
  contact_email?: string | null;
2161
- /** @description Other non-email contact information for the collection, e.g. phone and
2162
- * mailing address. This is visible to end users for support.
2145
+ /** @description Other non-email contact information for the collection, e.g. phone
2146
+ * and mailing address. This is visible to end users for support.
2163
2147
  * */
2164
2148
  contact_info?: string | null;
2165
2149
  /** @description Default directory when accessing the collection. This may include
2166
2150
  * the special string `$USER` which is evaluated at access time to be
2167
2151
  * the connector-specific username accessing the data.
2168
2152
  *
2169
- * If the collection is mapped collection with a
2170
- * **collection_base_path** value of `/`, this value can also begin
2171
- * with the values `/~/` and `$HOME`, which are replaced by the user's
2172
- * home directory, or `/` if the connector does not support the
2173
- * concept of a home directory.
2153
+ * If the collection is mapped collection with a **collection_base_path**
2154
+ * value of `/`, this value can also begin with the values `/~/` and
2155
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
2156
+ * the connector does not support the concept of a home directory.
2174
2157
  * */
2175
2158
  default_directory?: string;
2176
2159
  /** @description Flag indicating that this collection has been deleted */
2177
2160
  readonly deleted?: boolean;
2178
- /** @description Department within organization that runs the server(s).
2179
- * Searchable. Optional. Unicode string, max 1024
2180
- * characters, no new lines.
2161
+ /** @description Department within organization that runs the server(s). Searchable.
2162
+ * Optional. Unicode string, max 1024 characters, no new lines.
2181
2163
  * */
2182
2164
  department?: string | null;
2183
2165
  /** @description A description of the collection. */
@@ -2186,15 +2168,15 @@ export interface components {
2186
2168
  * checksums, needed for the verify_checksum option of transfer.
2187
2169
  * */
2188
2170
  disable_verify?: boolean;
2189
- /** @description Friendly name for the collection. Unicode string, max 128
2190
- * characters, no new lines (`\r` or `\n`).
2171
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
2172
+ * no new lines (`\r` or `\n`).
2191
2173
  * */
2192
2174
  display_name: string;
2193
2175
  domain?: components["schemas"]["Domain"];
2194
2176
  /** @description DNS name of the virtual host serving this collection. For mapped
2195
- * collections which do not have a custom domain, this may be specified as
2196
- * part of the input document to create the collection, otherwise this is
2197
- * a read-only property. When included in the input, the name is
2177
+ * collections which do not have a custom domain, this may be specified
2178
+ * as part of the input document to create the collection, otherwise this
2179
+ * is a read-only property. When included in the input, the name is
2198
2180
  * restricted to be a subdomain of the endpoint, and the input name label
2199
2181
  * may not start with `m-` or `g-`.
2200
2182
  * */
@@ -2210,8 +2192,7 @@ export interface components {
2210
2192
  *
2211
2193
  * __New in v5.4.17__: If a mapped collection forces encryption, all
2212
2194
  * of its guest collections must as well. If this option is used on a
2213
- * mapped collection, the value is propagated to its guest
2214
- * collections.
2195
+ * mapped collection, the value is propagated to its guest collections.
2215
2196
  * */
2216
2197
  force_encryption?: boolean;
2217
2198
  /** @description Flag indicating if this collection is created on a high assurance
@@ -2222,8 +2203,8 @@ export interface components {
2222
2203
  readonly https_url?: string;
2223
2204
  /**
2224
2205
  * Format: uuid
2225
- * @description Unique identifier for this collection. This is assigned
2226
- * by the GCS manager when creating a collection.
2206
+ * @description Unique identifier for this collection. This is assigned by the GCS
2207
+ * manager when creating a collection.
2227
2208
  *
2228
2209
  */
2229
2210
  readonly id?: string;
@@ -2236,9 +2217,8 @@ export interface components {
2236
2217
  identity_id?: string;
2237
2218
  /** @description Link to a web page with more information about the collection */
2238
2219
  info_link?: string | null;
2239
- /** @description List of search keywords for the
2240
- * endpoint. Optional. Unicode string, max 1024
2241
- * characters total across all strings.
2220
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
2221
+ * max 1024 characters total across all strings.
2242
2222
  * */
2243
2223
  keywords?: string[];
2244
2224
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -2285,8 +2265,8 @@ export interface components {
2285
2265
  * collections on this mapped collection.
2286
2266
  * */
2287
2267
  sharing_users_allow?: string[] | null;
2288
- /** @description List of connector-specific usernames denied access to
2289
- * create new guest collections on this mapped collection.
2268
+ /** @description List of connector-specific usernames denied access to create new guest
2269
+ * collections on this mapped collection.
2290
2270
  * */
2291
2271
  sharing_users_deny?: string[] | null;
2292
2272
  /**
@@ -2313,11 +2293,10 @@ export interface components {
2313
2293
  * message may be up to 64 characters long.
2314
2294
  * */
2315
2295
  user_message?: string | null;
2316
- /** @description Link to additional messaging for clients to display to users
2317
- * when interacting with this endpoint, linked to an
2318
- * HTTP or HTTPS URL. For guest collections, this property is
2319
- * read-only and is the same as the value of its related mapped
2320
- * collection.
2296
+ /** @description Link to additional messaging for clients to display to users when
2297
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
2298
+ * guest collections, this property is read-only and is the same as the
2299
+ * value of its related mapped collection.
2321
2300
  * */
2322
2301
  user_message_link?: string | null;
2323
2302
  };
@@ -2352,33 +2331,32 @@ export interface components {
2352
2331
  */
2353
2332
  DATA_TYPE: "collection#1.4.0";
2354
2333
  /** @description Flag indicating if this Collection allows users to create guest
2355
- * collections on it. This is always false if this is a guest
2356
- * collection. If this is changed to false on a mapped collection with
2357
- * associated guest collections, those collections will no longer be
2358
- * accessible.
2334
+ * collections on it. This is always false if this is a guest collection.
2335
+ * If this is changed to false on a mapped collection with associated
2336
+ * guest collections, those collections will no longer be accessible.
2359
2337
  * */
2360
2338
  allow_guest_collections?: boolean;
2361
2339
  /** @description Timeout (in minutes) during which a user is required to have
2362
2340
  * authenticated in a session to access this storage gateway.
2363
2341
  * */
2364
2342
  readonly authentication_timeout_mins?: number;
2365
- /** @description Path to be interpreted as the base path when creating a new
2366
- * collection. It is interpreted differently depending on the
2367
- * collection type being created. For a mapped collection, this is an
2368
- * absolute path on the storage system named by the
2369
- * storage_gateway_id. For a guest collection, this is a relative
2370
- * path relative to the value of the `root_path` attribute on the
2371
- * mapped collection with the same Id as the `mapped_collection_id`
2372
- * property. This may not be changed once the collection is created.
2343
+ /** @description Path to be interpreted as the base path when creating a new collection.
2344
+ * It is interpreted differently depending on the collection type being
2345
+ * created. For a mapped collection, this is an absolute path on the
2346
+ * storage system named by the storage_gateway_id. For a guest collection,
2347
+ * this is a relative path relative to the value of the `root_path`
2348
+ * attribute on the mapped collection with the same Id as the
2349
+ * `mapped_collection_id` property. This may not be changed once the
2350
+ * collection is created.
2373
2351
  *
2374
2352
  * Support for `~` was added in API version 1.21.0.
2375
2353
  * */
2376
2354
  collection_base_path: string;
2377
2355
  /**
2378
- * @description Type of collection. A `mapped` collection requires an account on
2379
- * the system to access the administrator-defined collection. A
2380
- * `guest` collection allows users to share access to their data on a
2381
- * Storage Gateway by registering a credential with the GCS Manager.
2356
+ * @description Type of collection. A `mapped` collection requires an account on the
2357
+ * system to access the administrator-defined collection. A `guest`
2358
+ * collection allows users to share access to their data on a Storage
2359
+ * Gateway by registering a credential with the GCS Manager.
2382
2360
  *
2383
2361
  * @enum {string}
2384
2362
  */
@@ -2388,30 +2366,29 @@ export interface components {
2388
2366
  * @description Id of the connector type that is used by this collection.
2389
2367
  */
2390
2368
  readonly connector_id?: string;
2391
- /** @description Email address of the support contact for this collection. This is visible
2392
- * to end users so that they may contact your organization for support.
2369
+ /** @description Email address of the support contact for this collection. This is
2370
+ * visible to end users so that they may contact your organization for
2371
+ * support.
2393
2372
  * */
2394
2373
  contact_email?: string | null;
2395
- /** @description Other non-email contact information for the collection, e.g. phone and
2396
- * mailing address. This is visible to end users for support.
2374
+ /** @description Other non-email contact information for the collection, e.g. phone
2375
+ * and mailing address. This is visible to end users for support.
2397
2376
  * */
2398
2377
  contact_info?: string | null;
2399
2378
  /** @description Default directory when accessing the collection. This may include
2400
2379
  * the special string `$USER` which is evaluated at access time to be
2401
2380
  * the connector-specific username accessing the data.
2402
2381
  *
2403
- * If the collection is mapped collection with a
2404
- * **collection_base_path** value of `/`, this value can also begin
2405
- * with the values `/~/` and `$HOME`, which are replaced by the user's
2406
- * home directory, or `/` if the connector does not support the
2407
- * concept of a home directory.
2382
+ * If the collection is mapped collection with a **collection_base_path**
2383
+ * value of `/`, this value can also begin with the values `/~/` and
2384
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
2385
+ * the connector does not support the concept of a home directory.
2408
2386
  * */
2409
2387
  default_directory?: string;
2410
2388
  /** @description Flag indicating that this collection has been deleted */
2411
2389
  readonly deleted?: boolean;
2412
- /** @description Department within organization that runs the server(s).
2413
- * Searchable. Optional. Unicode string, max 1024
2414
- * characters, no new lines.
2390
+ /** @description Department within organization that runs the server(s). Searchable.
2391
+ * Optional. Unicode string, max 1024 characters, no new lines.
2415
2392
  * */
2416
2393
  department?: string | null;
2417
2394
  /** @description A description of the collection. */
@@ -2420,15 +2397,15 @@ export interface components {
2420
2397
  * checksums, needed for the verify_checksum option of transfer.
2421
2398
  * */
2422
2399
  disable_verify?: boolean;
2423
- /** @description Friendly name for the collection. Unicode string, max 128
2424
- * characters, no new lines (`\r` or `\n`).
2400
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
2401
+ * no new lines (`\r` or `\n`).
2425
2402
  * */
2426
2403
  display_name: string;
2427
2404
  domain?: components["schemas"]["Domain"];
2428
2405
  /** @description DNS name of the virtual host serving this collection. For mapped
2429
- * collections which do not have a custom domain, this may be specified as
2430
- * part of the input document to create the collection, otherwise this is
2431
- * a read-only property. When included in the input, the name is
2406
+ * collections which do not have a custom domain, this may be specified
2407
+ * as part of the input document to create the collection, otherwise this
2408
+ * is a read-only property. When included in the input, the name is
2432
2409
  * restricted to be a subdomain of the endpoint, and the input name label
2433
2410
  * may not start with `m-` or `g-`.
2434
2411
  * */
@@ -2444,8 +2421,7 @@ export interface components {
2444
2421
  *
2445
2422
  * __New in v5.4.17__: If a mapped collection forces encryption, all
2446
2423
  * of its guest collections must as well. If this option is used on a
2447
- * mapped collection, the value is propagated to its guest
2448
- * collections.
2424
+ * mapped collection, the value is propagated to its guest collections.
2449
2425
  * */
2450
2426
  force_encryption?: boolean;
2451
2427
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -2460,8 +2436,8 @@ export interface components {
2460
2436
  readonly https_url?: string;
2461
2437
  /**
2462
2438
  * Format: uuid
2463
- * @description Unique identifier for this collection. This is assigned
2464
- * by the GCS manager when creating a collection.
2439
+ * @description Unique identifier for this collection. This is assigned by the GCS
2440
+ * manager when creating a collection.
2465
2441
  *
2466
2442
  */
2467
2443
  readonly id?: string;
@@ -2474,9 +2450,8 @@ export interface components {
2474
2450
  identity_id?: string;
2475
2451
  /** @description Link to a web page with more information about the collection */
2476
2452
  info_link?: string | null;
2477
- /** @description List of search keywords for the
2478
- * endpoint. Optional. Unicode string, max 1024
2479
- * characters total across all strings.
2453
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
2454
+ * max 1024 characters total across all strings.
2480
2455
  * */
2481
2456
  keywords?: string[];
2482
2457
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -2527,8 +2502,8 @@ export interface components {
2527
2502
  * collections on this mapped collection.
2528
2503
  * */
2529
2504
  sharing_users_allow?: string[] | null;
2530
- /** @description List of connector-specific usernames denied access to
2531
- * create new guest collections on this mapped collection.
2505
+ /** @description List of connector-specific usernames denied access to create new guest
2506
+ * collections on this mapped collection.
2532
2507
  * */
2533
2508
  sharing_users_deny?: string[] | null;
2534
2509
  /**
@@ -2555,11 +2530,10 @@ export interface components {
2555
2530
  * message may be up to 64 characters long.
2556
2531
  * */
2557
2532
  user_message?: string | null;
2558
- /** @description Link to additional messaging for clients to display to users
2559
- * when interacting with this endpoint, linked to an
2560
- * HTTP or HTTPS URL. For guest collections, this property is
2561
- * read-only and is the same as the value of its related mapped
2562
- * collection.
2533
+ /** @description Link to additional messaging for clients to display to users when
2534
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
2535
+ * guest collections, this property is read-only and is the same as the
2536
+ * value of its related mapped collection.
2563
2537
  * */
2564
2538
  user_message_link?: string | null;
2565
2539
  };
@@ -2597,33 +2571,32 @@ export interface components {
2597
2571
  */
2598
2572
  DATA_TYPE: "collection#1.5.0";
2599
2573
  /** @description Flag indicating if this Collection allows users to create guest
2600
- * collections on it. This is always false if this is a guest
2601
- * collection. If this is changed to false on a mapped collection with
2602
- * associated guest collections, those collections will no longer be
2603
- * accessible.
2574
+ * collections on it. This is always false if this is a guest collection.
2575
+ * If this is changed to false on a mapped collection with associated
2576
+ * guest collections, those collections will no longer be accessible.
2604
2577
  * */
2605
2578
  allow_guest_collections?: boolean;
2606
2579
  /** @description Timeout (in minutes) during which a user is required to have
2607
2580
  * authenticated in a session to access this storage gateway.
2608
2581
  * */
2609
2582
  readonly authentication_timeout_mins?: number;
2610
- /** @description Path to be interpreted as the base path when creating a new
2611
- * collection. It is interpreted differently depending on the
2612
- * collection type being created. For a mapped collection, this is an
2613
- * absolute path on the storage system named by the
2614
- * storage_gateway_id. For a guest collection, this is a relative
2615
- * path relative to the value of the `root_path` attribute on the
2616
- * mapped collection with the same Id as the `mapped_collection_id`
2617
- * property. This may not be changed once the collection is created.
2583
+ /** @description Path to be interpreted as the base path when creating a new collection.
2584
+ * It is interpreted differently depending on the collection type being
2585
+ * created. For a mapped collection, this is an absolute path on the
2586
+ * storage system named by the storage_gateway_id. For a guest collection,
2587
+ * this is a relative path relative to the value of the `root_path`
2588
+ * attribute on the mapped collection with the same Id as the
2589
+ * `mapped_collection_id` property. This may not be changed once the
2590
+ * collection is created.
2618
2591
  *
2619
2592
  * Support for `~` was added in API version 1.21.0.
2620
2593
  * */
2621
2594
  collection_base_path: string;
2622
2595
  /**
2623
- * @description Type of collection. A `mapped` collection requires an account on
2624
- * the system to access the administrator-defined collection. A
2625
- * `guest` collection allows users to share access to their data on a
2626
- * Storage Gateway by registering a credential with the GCS Manager.
2596
+ * @description Type of collection. A `mapped` collection requires an account on the
2597
+ * system to access the administrator-defined collection. A `guest`
2598
+ * collection allows users to share access to their data on a Storage
2599
+ * Gateway by registering a credential with the GCS Manager.
2627
2600
  *
2628
2601
  * @enum {string}
2629
2602
  */
@@ -2633,36 +2606,35 @@ export interface components {
2633
2606
  * @description Id of the connector type that is used by this collection.
2634
2607
  */
2635
2608
  readonly connector_id?: string;
2636
- /** @description Email address of the support contact for this collection. This is visible
2637
- * to end users so that they may contact your organization for support.
2609
+ /** @description Email address of the support contact for this collection. This is
2610
+ * visible to end users so that they may contact your organization for
2611
+ * support.
2638
2612
  * */
2639
2613
  contact_email?: string | null;
2640
- /** @description Other non-email contact information for the collection, e.g. phone and
2641
- * mailing address. This is visible to end users for support.
2614
+ /** @description Other non-email contact information for the collection, e.g. phone
2615
+ * and mailing address. This is visible to end users for support.
2642
2616
  * */
2643
2617
  contact_info?: string | null;
2644
2618
  /** @description Default directory when accessing the collection. This may include
2645
2619
  * the special string `$USER` which is evaluated at access time to be
2646
2620
  * the connector-specific username accessing the data.
2647
2621
  *
2648
- * If the collection is mapped collection with a
2649
- * **collection_base_path** value of `/`, this value can also begin
2650
- * with the values `/~/` and `$HOME`, which are replaced by the user's
2651
- * home directory, or `/` if the connector does not support the
2652
- * concept of a home directory.
2622
+ * If the collection is mapped collection with a **collection_base_path**
2623
+ * value of `/`, this value can also begin with the values `/~/` and
2624
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
2625
+ * the connector does not support the concept of a home directory.
2653
2626
  * */
2654
2627
  default_directory?: string;
2655
2628
  /** @description Flag indicating that this collection has been deleted */
2656
2629
  readonly deleted?: boolean;
2657
- /** @description Department within organization that runs the server(s).
2658
- * Searchable. Optional. Unicode string, max 1024
2659
- * characters, no new lines.
2630
+ /** @description Department within organization that runs the server(s). Searchable.
2631
+ * Optional. Unicode string, max 1024 characters, no new lines.
2660
2632
  * */
2661
2633
  department?: string | null;
2662
2634
  /** @description A description of the collection. */
2663
2635
  description?: string | null;
2664
- /** @description Flag indicating if guest collections on this mapped collection
2665
- * allow anonymous write permissions or not. This flag is always true for high
2636
+ /** @description Flag indicating if guest collections on this mapped collection allow
2637
+ * anonymous write permissions or not. This flag is always true for high
2666
2638
  * assurance collections. For non-high assurance mapped collections, the
2667
2639
  * default value is false.
2668
2640
  * */
@@ -2671,15 +2643,15 @@ export interface components {
2671
2643
  * checksums, needed for the verify_checksum option of transfer.
2672
2644
  * */
2673
2645
  disable_verify?: boolean;
2674
- /** @description Friendly name for the collection. Unicode string, max 128
2675
- * characters, no new lines (`\r` or `\n`).
2646
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
2647
+ * no new lines (`\r` or `\n`).
2676
2648
  * */
2677
2649
  display_name: string;
2678
2650
  domain?: components["schemas"]["Domain"];
2679
2651
  /** @description DNS name of the virtual host serving this collection. For mapped
2680
- * collections which do not have a custom domain, this may be specified as
2681
- * part of the input document to create the collection, otherwise this is
2682
- * a read-only property. When included in the input, the name is
2652
+ * collections which do not have a custom domain, this may be specified
2653
+ * as part of the input document to create the collection, otherwise this
2654
+ * is a read-only property. When included in the input, the name is
2683
2655
  * restricted to be a subdomain of the endpoint, and the input name label
2684
2656
  * may not start with `m-` or `g-`.
2685
2657
  * */
@@ -2695,8 +2667,7 @@ export interface components {
2695
2667
  *
2696
2668
  * __New in v5.4.17__: If a mapped collection forces encryption, all
2697
2669
  * of its guest collections must as well. If this option is used on a
2698
- * mapped collection, the value is propagated to its guest
2699
- * collections.
2670
+ * mapped collection, the value is propagated to its guest collections.
2700
2671
  * */
2701
2672
  force_encryption?: boolean;
2702
2673
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -2711,8 +2682,8 @@ export interface components {
2711
2682
  readonly https_url?: string;
2712
2683
  /**
2713
2684
  * Format: uuid
2714
- * @description Unique identifier for this collection. This is assigned
2715
- * by the GCS manager when creating a collection.
2685
+ * @description Unique identifier for this collection. This is assigned by the GCS
2686
+ * manager when creating a collection.
2716
2687
  *
2717
2688
  */
2718
2689
  readonly id?: string;
@@ -2725,9 +2696,8 @@ export interface components {
2725
2696
  identity_id?: string;
2726
2697
  /** @description Link to a web page with more information about the collection */
2727
2698
  info_link?: string | null;
2728
- /** @description List of search keywords for the
2729
- * endpoint. Optional. Unicode string, max 1024
2730
- * characters total across all strings.
2699
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
2700
+ * max 1024 characters total across all strings.
2731
2701
  * */
2732
2702
  keywords?: string[];
2733
2703
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -2778,8 +2748,8 @@ export interface components {
2778
2748
  * collections on this mapped collection.
2779
2749
  * */
2780
2750
  sharing_users_allow?: string[] | null;
2781
- /** @description List of connector-specific usernames denied access to
2782
- * create new guest collections on this mapped collection.
2751
+ /** @description List of connector-specific usernames denied access to create new guest
2752
+ * collections on this mapped collection.
2783
2753
  * */
2784
2754
  sharing_users_deny?: string[] | null;
2785
2755
  /**
@@ -2806,11 +2776,10 @@ export interface components {
2806
2776
  * message may be up to 64 characters long.
2807
2777
  * */
2808
2778
  user_message?: string | null;
2809
- /** @description Link to additional messaging for clients to display to users
2810
- * when interacting with this endpoint, linked to an
2811
- * HTTP or HTTPS URL. For guest collections, this property is
2812
- * read-only and is the same as the value of its related mapped
2813
- * collection.
2779
+ /** @description Link to additional messaging for clients to display to users when
2780
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
2781
+ * guest collections, this property is read-only and is the same as the
2782
+ * value of its related mapped collection.
2814
2783
  * */
2815
2784
  user_message_link?: string | null;
2816
2785
  };
@@ -2852,33 +2821,32 @@ export interface components {
2852
2821
  */
2853
2822
  DATA_TYPE: "collection#1.6.0";
2854
2823
  /** @description Flag indicating if this Collection allows users to create guest
2855
- * collections on it. This is always false if this is a guest
2856
- * collection. If this is changed to false on a mapped collection with
2857
- * associated guest collections, those collections will no longer be
2858
- * accessible.
2824
+ * collections on it. This is always false if this is a guest collection.
2825
+ * If this is changed to false on a mapped collection with associated
2826
+ * guest collections, those collections will no longer be accessible.
2859
2827
  * */
2860
2828
  allow_guest_collections?: boolean;
2861
2829
  /** @description Timeout (in minutes) during which a user is required to have
2862
2830
  * authenticated in a session to access this storage gateway.
2863
2831
  * */
2864
2832
  readonly authentication_timeout_mins?: number;
2865
- /** @description Path to be interpreted as the base path when creating a new
2866
- * collection. It is interpreted differently depending on the
2867
- * collection type being created. For a mapped collection, this is an
2868
- * absolute path on the storage system named by the
2869
- * storage_gateway_id. For a guest collection, this is a relative
2870
- * path relative to the value of the `root_path` attribute on the
2871
- * mapped collection with the same Id as the `mapped_collection_id`
2872
- * property. This may not be changed once the collection is created.
2833
+ /** @description Path to be interpreted as the base path when creating a new collection.
2834
+ * It is interpreted differently depending on the collection type being
2835
+ * created. For a mapped collection, this is an absolute path on the
2836
+ * storage system named by the storage_gateway_id. For a guest collection,
2837
+ * this is a relative path relative to the value of the `root_path`
2838
+ * attribute on the mapped collection with the same Id as the
2839
+ * `mapped_collection_id` property. This may not be changed once the
2840
+ * collection is created.
2873
2841
  *
2874
2842
  * Support for `~` was added in API version 1.21.0.
2875
2843
  * */
2876
2844
  collection_base_path: string;
2877
2845
  /**
2878
- * @description Type of collection. A `mapped` collection requires an account on
2879
- * the system to access the administrator-defined collection. A
2880
- * `guest` collection allows users to share access to their data on a
2881
- * Storage Gateway by registering a credential with the GCS Manager.
2846
+ * @description Type of collection. A `mapped` collection requires an account on the
2847
+ * system to access the administrator-defined collection. A `guest`
2848
+ * collection allows users to share access to their data on a Storage
2849
+ * Gateway by registering a credential with the GCS Manager.
2882
2850
  *
2883
2851
  * @enum {string}
2884
2852
  */
@@ -2888,36 +2856,35 @@ export interface components {
2888
2856
  * @description Id of the connector type that is used by this collection.
2889
2857
  */
2890
2858
  readonly connector_id?: string;
2891
- /** @description Email address of the support contact for this collection. This is visible
2892
- * to end users so that they may contact your organization for support.
2859
+ /** @description Email address of the support contact for this collection. This is
2860
+ * visible to end users so that they may contact your organization for
2861
+ * support.
2893
2862
  * */
2894
2863
  contact_email?: string | null;
2895
- /** @description Other non-email contact information for the collection, e.g. phone and
2896
- * mailing address. This is visible to end users for support.
2864
+ /** @description Other non-email contact information for the collection, e.g. phone
2865
+ * and mailing address. This is visible to end users for support.
2897
2866
  * */
2898
2867
  contact_info?: string | null;
2899
2868
  /** @description Default directory when accessing the collection. This may include
2900
2869
  * the special string `$USER` which is evaluated at access time to be
2901
2870
  * the connector-specific username accessing the data.
2902
2871
  *
2903
- * If the collection is mapped collection with a
2904
- * **collection_base_path** value of `/`, this value can also begin
2905
- * with the values `/~/` and `$HOME`, which are replaced by the user's
2906
- * home directory, or `/` if the connector does not support the
2907
- * concept of a home directory.
2872
+ * If the collection is mapped collection with a **collection_base_path**
2873
+ * value of `/`, this value can also begin with the values `/~/` and
2874
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
2875
+ * the connector does not support the concept of a home directory.
2908
2876
  * */
2909
2877
  default_directory?: string;
2910
2878
  /** @description Flag indicating that this collection has been deleted */
2911
2879
  readonly deleted?: boolean;
2912
- /** @description Department within organization that runs the server(s).
2913
- * Searchable. Optional. Unicode string, max 1024
2914
- * characters, no new lines.
2880
+ /** @description Department within organization that runs the server(s). Searchable.
2881
+ * Optional. Unicode string, max 1024 characters, no new lines.
2915
2882
  * */
2916
2883
  department?: string | null;
2917
2884
  /** @description A description of the collection. */
2918
2885
  description?: string | null;
2919
- /** @description Flag indicating if guest collections on this mapped collection
2920
- * allow anonymous write permissions or not. This flag is always true for high
2886
+ /** @description Flag indicating if guest collections on this mapped collection allow
2887
+ * anonymous write permissions or not. This flag is always true for high
2921
2888
  * assurance collections. For non-high assurance mapped collections, the
2922
2889
  * default value is false.
2923
2890
  * */
@@ -2926,15 +2893,15 @@ export interface components {
2926
2893
  * checksums, needed for the verify_checksum option of transfer.
2927
2894
  * */
2928
2895
  disable_verify?: boolean;
2929
- /** @description Friendly name for the collection. Unicode string, max 128
2930
- * characters, no new lines (`\r` or `\n`).
2896
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
2897
+ * no new lines (`\r` or `\n`).
2931
2898
  * */
2932
2899
  display_name: string;
2933
2900
  domain?: components["schemas"]["Domain"];
2934
2901
  /** @description DNS name of the virtual host serving this collection. For mapped
2935
- * collections which do not have a custom domain, this may be specified as
2936
- * part of the input document to create the collection, otherwise this is
2937
- * a read-only property. When included in the input, the name is
2902
+ * collections which do not have a custom domain, this may be specified
2903
+ * as part of the input document to create the collection, otherwise this
2904
+ * is a read-only property. When included in the input, the name is
2938
2905
  * restricted to be a subdomain of the endpoint, and the input name label
2939
2906
  * may not start with `m-` or `g-`.
2940
2907
  * */
@@ -2950,8 +2917,7 @@ export interface components {
2950
2917
  *
2951
2918
  * __New in v5.4.17__: If a mapped collection forces encryption, all
2952
2919
  * of its guest collections must as well. If this option is used on a
2953
- * mapped collection, the value is propagated to its guest
2954
- * collections.
2920
+ * mapped collection, the value is propagated to its guest collections.
2955
2921
  * */
2956
2922
  force_encryption?: boolean;
2957
2923
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -2975,8 +2941,8 @@ export interface components {
2975
2941
  readonly https_url?: string;
2976
2942
  /**
2977
2943
  * Format: uuid
2978
- * @description Unique identifier for this collection. This is assigned
2979
- * by the GCS manager when creating a collection.
2944
+ * @description Unique identifier for this collection. This is assigned by the GCS
2945
+ * manager when creating a collection.
2980
2946
  *
2981
2947
  */
2982
2948
  readonly id?: string;
@@ -2989,9 +2955,8 @@ export interface components {
2989
2955
  identity_id?: string;
2990
2956
  /** @description Link to a web page with more information about the collection */
2991
2957
  info_link?: string | null;
2992
- /** @description List of search keywords for the
2993
- * endpoint. Optional. Unicode string, max 1024
2994
- * characters total across all strings.
2958
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
2959
+ * max 1024 characters total across all strings.
2995
2960
  * */
2996
2961
  keywords?: string[];
2997
2962
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -3042,8 +3007,8 @@ export interface components {
3042
3007
  * collections on this mapped collection.
3043
3008
  * */
3044
3009
  sharing_users_allow?: string[] | null;
3045
- /** @description List of connector-specific usernames denied access to
3046
- * create new guest collections on this mapped collection.
3010
+ /** @description List of connector-specific usernames denied access to create new guest
3011
+ * collections on this mapped collection.
3047
3012
  * */
3048
3013
  sharing_users_deny?: string[] | null;
3049
3014
  /**
@@ -3070,11 +3035,10 @@ export interface components {
3070
3035
  * message may be up to 64 characters long.
3071
3036
  * */
3072
3037
  user_message?: string | null;
3073
- /** @description Link to additional messaging for clients to display to users
3074
- * when interacting with this endpoint, linked to an
3075
- * HTTP or HTTPS URL. For guest collections, this property is
3076
- * read-only and is the same as the value of its related mapped
3077
- * collection.
3038
+ /** @description Link to additional messaging for clients to display to users when
3039
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
3040
+ * guest collections, this property is read-only and is the same as the
3041
+ * value of its related mapped collection.
3078
3042
  * */
3079
3043
  user_message_link?: string | null;
3080
3044
  };
@@ -3119,33 +3083,32 @@ export interface components {
3119
3083
  */
3120
3084
  DATA_TYPE: "collection#1.7.0";
3121
3085
  /** @description Flag indicating if this Collection allows users to create guest
3122
- * collections on it. This is always false if this is a guest
3123
- * collection. If this is changed to false on a mapped collection with
3124
- * associated guest collections, those collections will no longer be
3125
- * accessible.
3086
+ * collections on it. This is always false if this is a guest collection.
3087
+ * If this is changed to false on a mapped collection with associated
3088
+ * guest collections, those collections will no longer be accessible.
3126
3089
  * */
3127
3090
  allow_guest_collections?: boolean;
3128
3091
  /** @description Timeout (in minutes) during which a user is required to have
3129
3092
  * authenticated in a session to access this storage gateway.
3130
3093
  * */
3131
3094
  readonly authentication_timeout_mins?: number;
3132
- /** @description Path to be interpreted as the base path when creating a new
3133
- * collection. It is interpreted differently depending on the
3134
- * collection type being created. For a mapped collection, this is an
3135
- * absolute path on the storage system named by the
3136
- * storage_gateway_id. For a guest collection, this is a relative
3137
- * path relative to the value of the `root_path` attribute on the
3138
- * mapped collection with the same Id as the `mapped_collection_id`
3139
- * property. This may not be changed once the collection is created.
3095
+ /** @description Path to be interpreted as the base path when creating a new collection.
3096
+ * It is interpreted differently depending on the collection type being
3097
+ * created. For a mapped collection, this is an absolute path on the
3098
+ * storage system named by the storage_gateway_id. For a guest collection,
3099
+ * this is a relative path relative to the value of the `root_path`
3100
+ * attribute on the mapped collection with the same Id as the
3101
+ * `mapped_collection_id` property. This may not be changed once the
3102
+ * collection is created.
3140
3103
  *
3141
3104
  * Support for `~` was added in API version 1.21.0.
3142
3105
  * */
3143
3106
  collection_base_path: string;
3144
3107
  /**
3145
- * @description Type of collection. A `mapped` collection requires an account on
3146
- * the system to access the administrator-defined collection. A
3147
- * `guest` collection allows users to share access to their data on a
3148
- * Storage Gateway by registering a credential with the GCS Manager.
3108
+ * @description Type of collection. A `mapped` collection requires an account on the
3109
+ * system to access the administrator-defined collection. A `guest`
3110
+ * collection allows users to share access to their data on a Storage
3111
+ * Gateway by registering a credential with the GCS Manager.
3149
3112
  *
3150
3113
  * @enum {string}
3151
3114
  */
@@ -3155,36 +3118,35 @@ export interface components {
3155
3118
  * @description Id of the connector type that is used by this collection.
3156
3119
  */
3157
3120
  readonly connector_id?: string;
3158
- /** @description Email address of the support contact for this collection. This is visible
3159
- * to end users so that they may contact your organization for support.
3121
+ /** @description Email address of the support contact for this collection. This is
3122
+ * visible to end users so that they may contact your organization for
3123
+ * support.
3160
3124
  * */
3161
3125
  contact_email?: string | null;
3162
- /** @description Other non-email contact information for the collection, e.g. phone and
3163
- * mailing address. This is visible to end users for support.
3126
+ /** @description Other non-email contact information for the collection, e.g. phone
3127
+ * and mailing address. This is visible to end users for support.
3164
3128
  * */
3165
3129
  contact_info?: string | null;
3166
3130
  /** @description Default directory when accessing the collection. This may include
3167
3131
  * the special string `$USER` which is evaluated at access time to be
3168
3132
  * the connector-specific username accessing the data.
3169
3133
  *
3170
- * If the collection is mapped collection with a
3171
- * **collection_base_path** value of `/`, this value can also begin
3172
- * with the values `/~/` and `$HOME`, which are replaced by the user's
3173
- * home directory, or `/` if the connector does not support the
3174
- * concept of a home directory.
3134
+ * If the collection is mapped collection with a **collection_base_path**
3135
+ * value of `/`, this value can also begin with the values `/~/` and
3136
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
3137
+ * the connector does not support the concept of a home directory.
3175
3138
  * */
3176
3139
  default_directory?: string;
3177
3140
  /** @description Flag indicating that this collection has been deleted */
3178
3141
  readonly deleted?: boolean;
3179
- /** @description Department within organization that runs the server(s).
3180
- * Searchable. Optional. Unicode string, max 1024
3181
- * characters, no new lines.
3142
+ /** @description Department within organization that runs the server(s). Searchable.
3143
+ * Optional. Unicode string, max 1024 characters, no new lines.
3182
3144
  * */
3183
3145
  department?: string | null;
3184
3146
  /** @description A description of the collection. */
3185
3147
  description?: string | null;
3186
- /** @description Flag indicating if guest collections on this mapped collection
3187
- * allow anonymous write permissions or not. This flag is always true for high
3148
+ /** @description Flag indicating if guest collections on this mapped collection allow
3149
+ * anonymous write permissions or not. This flag is always true for high
3188
3150
  * assurance collections. For non-high assurance mapped collections, the
3189
3151
  * default value is false.
3190
3152
  * */
@@ -3193,15 +3155,15 @@ export interface components {
3193
3155
  * checksums, needed for the verify_checksum option of transfer.
3194
3156
  * */
3195
3157
  disable_verify?: boolean;
3196
- /** @description Friendly name for the collection. Unicode string, max 128
3197
- * characters, no new lines (`\r` or `\n`).
3158
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
3159
+ * no new lines (`\r` or `\n`).
3198
3160
  * */
3199
3161
  display_name: string;
3200
3162
  domain?: components["schemas"]["Domain"];
3201
3163
  /** @description DNS name of the virtual host serving this collection. For mapped
3202
- * collections which do not have a custom domain, this may be specified as
3203
- * part of the input document to create the collection, otherwise this is
3204
- * a read-only property. When included in the input, the name is
3164
+ * collections which do not have a custom domain, this may be specified
3165
+ * as part of the input document to create the collection, otherwise this
3166
+ * is a read-only property. When included in the input, the name is
3205
3167
  * restricted to be a subdomain of the endpoint, and the input name label
3206
3168
  * may not start with `m-` or `g-`.
3207
3169
  * */
@@ -3217,8 +3179,7 @@ export interface components {
3217
3179
  *
3218
3180
  * __New in v5.4.17__: If a mapped collection forces encryption, all
3219
3181
  * of its guest collections must as well. If this option is used on a
3220
- * mapped collection, the value is propagated to its guest
3221
- * collections.
3182
+ * mapped collection, the value is propagated to its guest collections.
3222
3183
  * */
3223
3184
  force_encryption?: boolean;
3224
3185
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -3242,8 +3203,8 @@ export interface components {
3242
3203
  readonly https_url?: string;
3243
3204
  /**
3244
3205
  * Format: uuid
3245
- * @description Unique identifier for this collection. This is assigned
3246
- * by the GCS manager when creating a collection.
3206
+ * @description Unique identifier for this collection. This is assigned by the GCS
3207
+ * manager when creating a collection.
3247
3208
  *
3248
3209
  */
3249
3210
  readonly id?: string;
@@ -3256,9 +3217,8 @@ export interface components {
3256
3217
  identity_id?: string;
3257
3218
  /** @description Link to a web page with more information about the collection */
3258
3219
  info_link?: string | null;
3259
- /** @description List of search keywords for the
3260
- * endpoint. Optional. Unicode string, max 1024
3261
- * characters total across all strings.
3220
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
3221
+ * max 1024 characters total across all strings.
3262
3222
  * */
3263
3223
  keywords?: string[];
3264
3224
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -3309,8 +3269,8 @@ export interface components {
3309
3269
  * collections on this mapped collection.
3310
3270
  * */
3311
3271
  sharing_users_allow?: string[] | null;
3312
- /** @description List of connector-specific usernames denied access to
3313
- * create new guest collections on this mapped collection.
3272
+ /** @description List of connector-specific usernames denied access to create new guest
3273
+ * collections on this mapped collection.
3314
3274
  * */
3315
3275
  sharing_users_deny?: string[] | null;
3316
3276
  /**
@@ -3337,11 +3297,10 @@ export interface components {
3337
3297
  * message may be up to 256 characters long.
3338
3298
  * */
3339
3299
  user_message?: string | null;
3340
- /** @description Link to additional messaging for clients to display to users
3341
- * when interacting with this endpoint, linked to an
3342
- * HTTP or HTTPS URL. For guest collections, this property is
3343
- * read-only and is the same as the value of its related mapped
3344
- * collection.
3300
+ /** @description Link to additional messaging for clients to display to users when
3301
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
3302
+ * guest collections, this property is read-only and is the same as the
3303
+ * value of its related mapped collection.
3345
3304
  * */
3346
3305
  user_message_link?: string | null;
3347
3306
  };
@@ -3390,33 +3349,32 @@ export interface components {
3390
3349
  */
3391
3350
  DATA_TYPE: "collection#1.8.0";
3392
3351
  /** @description Flag indicating if this Collection allows users to create guest
3393
- * collections on it. This is always false if this is a guest
3394
- * collection. If this is changed to false on a mapped collection with
3395
- * associated guest collections, those collections will no longer be
3396
- * accessible.
3352
+ * collections on it. This is always false if this is a guest collection.
3353
+ * If this is changed to false on a mapped collection with associated
3354
+ * guest collections, those collections will no longer be accessible.
3397
3355
  * */
3398
3356
  allow_guest_collections?: boolean;
3399
3357
  /** @description Timeout (in minutes) during which a user is required to have
3400
3358
  * authenticated in a session to access this storage gateway.
3401
3359
  * */
3402
3360
  readonly authentication_timeout_mins?: number;
3403
- /** @description Path to be interpreted as the base path when creating a new
3404
- * collection. It is interpreted differently depending on the
3405
- * collection type being created. For a mapped collection, this is an
3406
- * absolute path on the storage system named by the
3407
- * storage_gateway_id. For a guest collection, this is a relative
3408
- * path relative to the value of the `root_path` attribute on the
3409
- * mapped collection with the same Id as the `mapped_collection_id`
3410
- * property. This may not be changed once the collection is created.
3361
+ /** @description Path to be interpreted as the base path when creating a new collection.
3362
+ * It is interpreted differently depending on the collection type being
3363
+ * created. For a mapped collection, this is an absolute path on the
3364
+ * storage system named by the storage_gateway_id. For a guest collection,
3365
+ * this is a relative path relative to the value of the `root_path`
3366
+ * attribute on the mapped collection with the same Id as the
3367
+ * `mapped_collection_id` property. This may not be changed once the
3368
+ * collection is created.
3411
3369
  *
3412
3370
  * Support for `~` was added in API version 1.21.0.
3413
3371
  * */
3414
3372
  collection_base_path: string;
3415
3373
  /**
3416
- * @description Type of collection. A `mapped` collection requires an account on
3417
- * the system to access the administrator-defined collection. A
3418
- * `guest` collection allows users to share access to their data on a
3419
- * Storage Gateway by registering a credential with the GCS Manager.
3374
+ * @description Type of collection. A `mapped` collection requires an account on the
3375
+ * system to access the administrator-defined collection. A `guest`
3376
+ * collection allows users to share access to their data on a Storage
3377
+ * Gateway by registering a credential with the GCS Manager.
3420
3378
  *
3421
3379
  * @enum {string}
3422
3380
  */
@@ -3426,23 +3384,23 @@ export interface components {
3426
3384
  * @description Id of the connector type that is used by this collection.
3427
3385
  */
3428
3386
  readonly connector_id?: string;
3429
- /** @description Email address of the support contact for this collection. This is visible
3430
- * to end users so that they may contact your organization for support.
3387
+ /** @description Email address of the support contact for this collection. This is
3388
+ * visible to end users so that they may contact your organization for
3389
+ * support.
3431
3390
  * */
3432
3391
  contact_email?: string | null;
3433
- /** @description Other non-email contact information for the collection, e.g. phone and
3434
- * mailing address. This is visible to end users for support.
3392
+ /** @description Other non-email contact information for the collection, e.g. phone
3393
+ * and mailing address. This is visible to end users for support.
3435
3394
  * */
3436
3395
  contact_info?: string | null;
3437
3396
  /** @description Default directory when accessing the collection. This may include
3438
3397
  * the special string `$USER` which is evaluated at access time to be
3439
3398
  * the connector-specific username accessing the data.
3440
3399
  *
3441
- * If the collection is mapped collection with a
3442
- * **collection_base_path** value of `/`, this value can also begin
3443
- * with the values `/~/` and `$HOME`, which are replaced by the user's
3444
- * home directory, or `/` if the connector does not support the
3445
- * concept of a home directory.
3400
+ * If the collection is mapped collection with a **collection_base_path**
3401
+ * value of `/`, this value can also begin with the values `/~/` and
3402
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
3403
+ * the connector does not support the concept of a home directory.
3446
3404
  * */
3447
3405
  default_directory?: string;
3448
3406
  /** @description If set to true, this collection can not be deleted. This property
@@ -3452,15 +3410,14 @@ export interface components {
3452
3410
  delete_protected?: boolean;
3453
3411
  /** @description Flag indicating that this collection has been deleted */
3454
3412
  readonly deleted?: boolean;
3455
- /** @description Department within organization that runs the server(s).
3456
- * Searchable. Optional. Unicode string, max 1024
3457
- * characters, no new lines.
3413
+ /** @description Department within organization that runs the server(s). Searchable.
3414
+ * Optional. Unicode string, max 1024 characters, no new lines.
3458
3415
  * */
3459
3416
  department?: string | null;
3460
3417
  /** @description A description of the collection. */
3461
3418
  description?: string | null;
3462
- /** @description Flag indicating if guest collections on this mapped collection
3463
- * allow anonymous write permissions or not. This flag is always true for high
3419
+ /** @description Flag indicating if guest collections on this mapped collection allow
3420
+ * anonymous write permissions or not. This flag is always true for high
3464
3421
  * assurance collections. For non-high assurance mapped collections, the
3465
3422
  * default value is false.
3466
3423
  * */
@@ -3469,15 +3426,15 @@ export interface components {
3469
3426
  * checksums, needed for the verify_checksum option of transfer.
3470
3427
  * */
3471
3428
  disable_verify?: boolean;
3472
- /** @description Friendly name for the collection. Unicode string, max 128
3473
- * characters, no new lines (`\r` or `\n`).
3429
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
3430
+ * no new lines (`\r` or `\n`).
3474
3431
  * */
3475
3432
  display_name: string;
3476
3433
  domain?: components["schemas"]["Domain"];
3477
3434
  /** @description DNS name of the virtual host serving this collection. For mapped
3478
- * collections which do not have a custom domain, this may be specified as
3479
- * part of the input document to create the collection, otherwise this is
3480
- * a read-only property. When included in the input, the name is
3435
+ * collections which do not have a custom domain, this may be specified
3436
+ * as part of the input document to create the collection, otherwise this
3437
+ * is a read-only property. When included in the input, the name is
3481
3438
  * restricted to be a subdomain of the endpoint, and the input name label
3482
3439
  * may not start with `m-` or `g-`.
3483
3440
  * */
@@ -3493,8 +3450,7 @@ export interface components {
3493
3450
  *
3494
3451
  * __New in v5.4.17__: If a mapped collection forces encryption, all
3495
3452
  * of its guest collections must as well. If this option is used on a
3496
- * mapped collection, the value is propagated to its guest
3497
- * collections.
3453
+ * mapped collection, the value is propagated to its guest collections.
3498
3454
  * */
3499
3455
  force_encryption?: boolean;
3500
3456
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -3518,8 +3474,8 @@ export interface components {
3518
3474
  readonly https_url?: string;
3519
3475
  /**
3520
3476
  * Format: uuid
3521
- * @description Unique identifier for this collection. This is assigned
3522
- * by the GCS manager when creating a collection.
3477
+ * @description Unique identifier for this collection. This is assigned by the GCS
3478
+ * manager when creating a collection.
3523
3479
  *
3524
3480
  */
3525
3481
  readonly id?: string;
@@ -3532,9 +3488,8 @@ export interface components {
3532
3488
  identity_id?: string;
3533
3489
  /** @description Link to a web page with more information about the collection */
3534
3490
  info_link?: string | null;
3535
- /** @description List of search keywords for the
3536
- * endpoint. Optional. Unicode string, max 1024
3537
- * characters total across all strings.
3491
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
3492
+ * max 1024 characters total across all strings.
3538
3493
  * */
3539
3494
  keywords?: string[];
3540
3495
  /** @description URL of the GCS Manager API service for the endpoint hosting this
@@ -3585,8 +3540,8 @@ export interface components {
3585
3540
  * collections on this mapped collection.
3586
3541
  * */
3587
3542
  sharing_users_allow?: string[] | null;
3588
- /** @description List of connector-specific usernames denied access to
3589
- * create new guest collections on this mapped collection.
3543
+ /** @description List of connector-specific usernames denied access to create new guest
3544
+ * collections on this mapped collection.
3590
3545
  * */
3591
3546
  sharing_users_deny?: string[] | null;
3592
3547
  /**
@@ -3613,11 +3568,10 @@ export interface components {
3613
3568
  * message may be up to 256 characters long.
3614
3569
  * */
3615
3570
  user_message?: string | null;
3616
- /** @description Link to additional messaging for clients to display to users
3617
- * when interacting with this endpoint, linked to an
3618
- * HTTP or HTTPS URL. For guest collections, this property is
3619
- * read-only and is the same as the value of its related mapped
3620
- * collection.
3571
+ /** @description Link to additional messaging for clients to display to users when
3572
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
3573
+ * guest collections, this property is read-only and is the same as the
3574
+ * value of its related mapped collection.
3621
3575
  * */
3622
3576
  user_message_link?: string | null;
3623
3577
  };
@@ -3668,33 +3622,32 @@ export interface components {
3668
3622
  */
3669
3623
  DATA_TYPE: "collection#1.9.0";
3670
3624
  /** @description Flag indicating if this Collection allows users to create guest
3671
- * collections on it. This is always false if this is a guest
3672
- * collection. If this is changed to false on a mapped collection with
3673
- * associated guest collections, those collections will no longer be
3674
- * accessible.
3625
+ * collections on it. This is always false if this is a guest collection.
3626
+ * If this is changed to false on a mapped collection with associated
3627
+ * guest collections, those collections will no longer be accessible.
3675
3628
  * */
3676
3629
  allow_guest_collections?: boolean;
3677
3630
  /** @description Timeout (in minutes) during which a user is required to have
3678
3631
  * authenticated in a session to access this storage gateway.
3679
3632
  * */
3680
3633
  readonly authentication_timeout_mins?: number;
3681
- /** @description Path to be interpreted as the base path when creating a new
3682
- * collection. It is interpreted differently depending on the
3683
- * collection type being created. For a mapped collection, this is an
3684
- * absolute path on the storage system named by the
3685
- * storage_gateway_id. For a guest collection, this is a relative
3686
- * path relative to the value of the `root_path` attribute on the
3687
- * mapped collection with the same Id as the `mapped_collection_id`
3688
- * property. This may not be changed once the collection is created.
3634
+ /** @description Path to be interpreted as the base path when creating a new collection.
3635
+ * It is interpreted differently depending on the collection type being
3636
+ * created. For a mapped collection, this is an absolute path on the
3637
+ * storage system named by the storage_gateway_id. For a guest collection,
3638
+ * this is a relative path relative to the value of the `root_path`
3639
+ * attribute on the mapped collection with the same Id as the
3640
+ * `mapped_collection_id` property. This may not be changed once the
3641
+ * collection is created.
3689
3642
  *
3690
3643
  * Support for `~` was added in API version 1.21.0.
3691
3644
  * */
3692
3645
  collection_base_path: string;
3693
3646
  /**
3694
- * @description Type of collection. A `mapped` collection requires an account on
3695
- * the system to access the administrator-defined collection. A
3696
- * `guest` collection allows users to share access to their data on a
3697
- * Storage Gateway by registering a credential with the GCS Manager.
3647
+ * @description Type of collection. A `mapped` collection requires an account on the
3648
+ * system to access the administrator-defined collection. A `guest`
3649
+ * collection allows users to share access to their data on a Storage
3650
+ * Gateway by registering a credential with the GCS Manager.
3698
3651
  *
3699
3652
  * @enum {string}
3700
3653
  */
@@ -3704,12 +3657,13 @@ export interface components {
3704
3657
  * @description Id of the connector type that is used by this collection.
3705
3658
  */
3706
3659
  readonly connector_id?: string;
3707
- /** @description Email address of the support contact for this collection. This is visible
3708
- * to end users so that they may contact your organization for support.
3660
+ /** @description Email address of the support contact for this collection. This is
3661
+ * visible to end users so that they may contact your organization for
3662
+ * support.
3709
3663
  * */
3710
3664
  contact_email?: string | null;
3711
- /** @description Other non-email contact information for the collection, e.g. phone and
3712
- * mailing address. This is visible to end users for support.
3665
+ /** @description Other non-email contact information for the collection, e.g. phone
3666
+ * and mailing address. This is visible to end users for support.
3713
3667
  * */
3714
3668
  contact_info?: string | null;
3715
3669
  /**
@@ -3721,11 +3675,10 @@ export interface components {
3721
3675
  * the special string `$USER` which is evaluated at access time to be
3722
3676
  * the connector-specific username accessing the data.
3723
3677
  *
3724
- * If the collection is mapped collection with a
3725
- * **collection_base_path** value of `/`, this value can also begin
3726
- * with the values `/~/` and `$HOME`, which are replaced by the user's
3727
- * home directory, or `/` if the connector does not support the
3728
- * concept of a home directory.
3678
+ * If the collection is mapped collection with a **collection_base_path**
3679
+ * value of `/`, this value can also begin with the values `/~/` and
3680
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
3681
+ * the connector does not support the concept of a home directory.
3729
3682
  * */
3730
3683
  default_directory?: string;
3731
3684
  /** @description If set to true, this collection can not be deleted. This property
@@ -3735,15 +3688,14 @@ export interface components {
3735
3688
  delete_protected?: boolean;
3736
3689
  /** @description Flag indicating that this collection has been deleted */
3737
3690
  readonly deleted?: boolean;
3738
- /** @description Department within organization that runs the server(s).
3739
- * Searchable. Optional. Unicode string, max 1024
3740
- * characters, no new lines.
3691
+ /** @description Department within organization that runs the server(s). Searchable.
3692
+ * Optional. Unicode string, max 1024 characters, no new lines.
3741
3693
  * */
3742
3694
  department?: string | null;
3743
3695
  /** @description A description of the collection. */
3744
3696
  description?: string | null;
3745
- /** @description Flag indicating if guest collections on this mapped collection
3746
- * allow anonymous write permissions or not. This flag is always true for high
3697
+ /** @description Flag indicating if guest collections on this mapped collection allow
3698
+ * anonymous write permissions or not. This flag is always true for high
3747
3699
  * assurance collections. For non-high assurance mapped collections, the
3748
3700
  * default value is false.
3749
3701
  * */
@@ -3752,15 +3704,15 @@ export interface components {
3752
3704
  * checksums, needed for the verify_checksum option of transfer.
3753
3705
  * */
3754
3706
  disable_verify?: boolean;
3755
- /** @description Friendly name for the collection. Unicode string, max 128
3756
- * characters, no new lines (`\r` or `\n`).
3707
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
3708
+ * no new lines (`\r` or `\n`).
3757
3709
  * */
3758
3710
  display_name: string;
3759
3711
  domain?: components["schemas"]["Domain"];
3760
3712
  /** @description DNS name of the virtual host serving this collection. For mapped
3761
- * collections which do not have a custom domain, this may be specified as
3762
- * part of the input document to create the collection, otherwise this is
3763
- * a read-only property. When included in the input, the name is
3713
+ * collections which do not have a custom domain, this may be specified
3714
+ * as part of the input document to create the collection, otherwise this
3715
+ * is a read-only property. When included in the input, the name is
3764
3716
  * restricted to be a subdomain of the endpoint, and the input name label
3765
3717
  * may not start with `m-` or `g-`.
3766
3718
  * */
@@ -3776,8 +3728,7 @@ export interface components {
3776
3728
  *
3777
3729
  * __New in v5.4.17__: If a mapped collection forces encryption, all
3778
3730
  * of its guest collections must as well. If this option is used on a
3779
- * mapped collection, the value is propagated to its guest
3780
- * collections.
3731
+ * mapped collection, the value is propagated to its guest collections.
3781
3732
  * */
3782
3733
  force_encryption?: boolean;
3783
3734
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -3801,8 +3752,8 @@ export interface components {
3801
3752
  readonly https_url?: string;
3802
3753
  /**
3803
3754
  * Format: uuid
3804
- * @description Unique identifier for this collection. This is assigned
3805
- * by the GCS manager when creating a collection.
3755
+ * @description Unique identifier for this collection. This is assigned by the GCS
3756
+ * manager when creating a collection.
3806
3757
  *
3807
3758
  */
3808
3759
  readonly id?: string;
@@ -3815,9 +3766,8 @@ export interface components {
3815
3766
  identity_id?: string;
3816
3767
  /** @description Link to a web page with more information about the collection */
3817
3768
  info_link?: string | null;
3818
- /** @description List of search keywords for the
3819
- * endpoint. Optional. Unicode string, max 1024
3820
- * characters total across all strings.
3769
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
3770
+ * max 1024 characters total across all strings.
3821
3771
  * */
3822
3772
  keywords?: string[];
3823
3773
  /**
@@ -3873,8 +3823,8 @@ export interface components {
3873
3823
  * collections on this mapped collection.
3874
3824
  * */
3875
3825
  sharing_users_allow?: string[] | null;
3876
- /** @description List of connector-specific usernames denied access to
3877
- * create new guest collections on this mapped collection.
3826
+ /** @description List of connector-specific usernames denied access to create new guest
3827
+ * collections on this mapped collection.
3878
3828
  * */
3879
3829
  sharing_users_deny?: string[] | null;
3880
3830
  /**
@@ -3901,11 +3851,10 @@ export interface components {
3901
3851
  * message may be up to 256 characters long.
3902
3852
  * */
3903
3853
  user_message?: string | null;
3904
- /** @description Link to additional messaging for clients to display to users
3905
- * when interacting with this endpoint, linked to an
3906
- * HTTP or HTTPS URL. For guest collections, this property is
3907
- * read-only and is the same as the value of its related mapped
3908
- * collection.
3854
+ /** @description Link to additional messaging for clients to display to users when
3855
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
3856
+ * guest collections, this property is read-only and is the same as the
3857
+ * value of its related mapped collection.
3909
3858
  * */
3910
3859
  user_message_link?: string | null;
3911
3860
  };
@@ -3957,36 +3906,38 @@ export interface components {
3957
3906
  * @enum {string}
3958
3907
  */
3959
3908
  DATA_TYPE: "collection#1.10.0";
3960
- /** @description Length of time that guest collection permissions are valid. Only settable on HA mapped collections and used by the guest collections attached to it. Set to null to delete any previously set value. */
3909
+ /** @description Length of time that guest collection permissions are valid. Only
3910
+ * settable on HA mapped collections and used by the guest collections
3911
+ * attached to it. Set to null to delete any previously set value.
3912
+ * */
3961
3913
  acl_expiration_mins?: number | null;
3962
3914
  /** @description Flag indicating if this Collection allows users to create guest
3963
- * collections on it. This is always false if this is a guest
3964
- * collection. If this is changed to false on a mapped collection with
3965
- * associated guest collections, those collections will no longer be
3966
- * accessible.
3915
+ * collections on it. This is always false if this is a guest collection.
3916
+ * If this is changed to false on a mapped collection with associated
3917
+ * guest collections, those collections will no longer be accessible.
3967
3918
  * */
3968
3919
  allow_guest_collections?: boolean;
3969
3920
  /** @description Timeout (in minutes) during which a user is required to have
3970
3921
  * authenticated in a session to access this storage gateway.
3971
3922
  * */
3972
3923
  readonly authentication_timeout_mins?: number;
3973
- /** @description Path to be interpreted as the base path when creating a new
3974
- * collection. It is interpreted differently depending on the
3975
- * collection type being created. For a mapped collection, this is an
3976
- * absolute path on the storage system named by the
3977
- * storage_gateway_id. For a guest collection, this is a relative
3978
- * path relative to the value of the `root_path` attribute on the
3979
- * mapped collection with the same Id as the `mapped_collection_id`
3980
- * property. This may not be changed once the collection is created.
3924
+ /** @description Path to be interpreted as the base path when creating a new collection.
3925
+ * It is interpreted differently depending on the collection type being
3926
+ * created. For a mapped collection, this is an absolute path on the
3927
+ * storage system named by the storage_gateway_id. For a guest collection,
3928
+ * this is a relative path relative to the value of the `root_path`
3929
+ * attribute on the mapped collection with the same Id as the
3930
+ * `mapped_collection_id` property. This may not be changed once the
3931
+ * collection is created.
3981
3932
  *
3982
3933
  * Support for `~` was added in API version 1.21.0.
3983
3934
  * */
3984
3935
  collection_base_path: string;
3985
3936
  /**
3986
- * @description Type of collection. A `mapped` collection requires an account on
3987
- * the system to access the administrator-defined collection. A
3988
- * `guest` collection allows users to share access to their data on a
3989
- * Storage Gateway by registering a credential with the GCS Manager.
3937
+ * @description Type of collection. A `mapped` collection requires an account on the
3938
+ * system to access the administrator-defined collection. A `guest`
3939
+ * collection allows users to share access to their data on a Storage
3940
+ * Gateway by registering a credential with the GCS Manager.
3990
3941
  *
3991
3942
  * @enum {string}
3992
3943
  */
@@ -3996,12 +3947,13 @@ export interface components {
3996
3947
  * @description Id of the connector type that is used by this collection.
3997
3948
  */
3998
3949
  readonly connector_id?: string;
3999
- /** @description Email address of the support contact for this collection. This is visible
4000
- * to end users so that they may contact your organization for support.
3950
+ /** @description Email address of the support contact for this collection. This is
3951
+ * visible to end users so that they may contact your organization for
3952
+ * support.
4001
3953
  * */
4002
3954
  contact_email?: string | null;
4003
- /** @description Other non-email contact information for the collection, e.g. phone and
4004
- * mailing address. This is visible to end users for support.
3955
+ /** @description Other non-email contact information for the collection, e.g. phone
3956
+ * and mailing address. This is visible to end users for support.
4005
3957
  * */
4006
3958
  contact_info?: string | null;
4007
3959
  /**
@@ -4013,11 +3965,10 @@ export interface components {
4013
3965
  * the special string `$USER` which is evaluated at access time to be
4014
3966
  * the connector-specific username accessing the data.
4015
3967
  *
4016
- * If the collection is mapped collection with a
4017
- * **collection_base_path** value of `/`, this value can also begin
4018
- * with the values `/~/` and `$HOME`, which are replaced by the user's
4019
- * home directory, or `/` if the connector does not support the
4020
- * concept of a home directory.
3968
+ * If the collection is mapped collection with a **collection_base_path**
3969
+ * value of `/`, this value can also begin with the values `/~/` and
3970
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
3971
+ * the connector does not support the concept of a home directory.
4021
3972
  * */
4022
3973
  default_directory?: string;
4023
3974
  /** @description If set to true, this collection can not be deleted. This property
@@ -4027,15 +3978,14 @@ export interface components {
4027
3978
  delete_protected?: boolean;
4028
3979
  /** @description Flag indicating that this collection has been deleted */
4029
3980
  readonly deleted?: boolean;
4030
- /** @description Department within organization that runs the server(s).
4031
- * Searchable. Optional. Unicode string, max 1024
4032
- * characters, no new lines.
3981
+ /** @description Department within organization that runs the server(s). Searchable.
3982
+ * Optional. Unicode string, max 1024 characters, no new lines.
4033
3983
  * */
4034
3984
  department?: string | null;
4035
3985
  /** @description A description of the collection. */
4036
3986
  description?: string | null;
4037
- /** @description Flag indicating if guest collections on this mapped collection
4038
- * allow anonymous write permissions or not. This flag is always true for high
3987
+ /** @description Flag indicating if guest collections on this mapped collection allow
3988
+ * anonymous write permissions or not. This flag is always true for high
4039
3989
  * assurance collections. For non-high assurance mapped collections, the
4040
3990
  * default value is false.
4041
3991
  * */
@@ -4044,15 +3994,15 @@ export interface components {
4044
3994
  * checksums, needed for the verify_checksum option of transfer.
4045
3995
  * */
4046
3996
  disable_verify?: boolean;
4047
- /** @description Friendly name for the collection. Unicode string, max 128
4048
- * characters, no new lines (`\r` or `\n`).
3997
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
3998
+ * no new lines (`\r` or `\n`).
4049
3999
  * */
4050
4000
  display_name: string;
4051
4001
  domain?: components["schemas"]["Domain"];
4052
4002
  /** @description DNS name of the virtual host serving this collection. For mapped
4053
- * collections which do not have a custom domain, this may be specified as
4054
- * part of the input document to create the collection, otherwise this is
4055
- * a read-only property. When included in the input, the name is
4003
+ * collections which do not have a custom domain, this may be specified
4004
+ * as part of the input document to create the collection, otherwise this
4005
+ * is a read-only property. When included in the input, the name is
4056
4006
  * restricted to be a subdomain of the endpoint, and the input name label
4057
4007
  * may not start with `m-` or `g-`.
4058
4008
  * */
@@ -4068,8 +4018,7 @@ export interface components {
4068
4018
  *
4069
4019
  * __New in v5.4.17__: If a mapped collection forces encryption, all
4070
4020
  * of its guest collections must as well. If this option is used on a
4071
- * mapped collection, the value is propagated to its guest
4072
- * collections.
4021
+ * mapped collection, the value is propagated to its guest collections.
4073
4022
  * */
4074
4023
  force_encryption?: boolean;
4075
4024
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -4093,8 +4042,8 @@ export interface components {
4093
4042
  readonly https_url?: string;
4094
4043
  /**
4095
4044
  * Format: uuid
4096
- * @description Unique identifier for this collection. This is assigned
4097
- * by the GCS manager when creating a collection.
4045
+ * @description Unique identifier for this collection. This is assigned by the GCS
4046
+ * manager when creating a collection.
4098
4047
  *
4099
4048
  */
4100
4049
  readonly id?: string;
@@ -4107,9 +4056,8 @@ export interface components {
4107
4056
  identity_id?: string;
4108
4057
  /** @description Link to a web page with more information about the collection */
4109
4058
  info_link?: string | null;
4110
- /** @description List of search keywords for the
4111
- * endpoint. Optional. Unicode string, max 1024
4112
- * characters total across all strings.
4059
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
4060
+ * max 1024 characters total across all strings.
4113
4061
  * */
4114
4062
  keywords?: string[];
4115
4063
  /**
@@ -4165,8 +4113,8 @@ export interface components {
4165
4113
  * collections on this mapped collection.
4166
4114
  * */
4167
4115
  sharing_users_allow?: string[] | null;
4168
- /** @description List of connector-specific usernames denied access to
4169
- * create new guest collections on this mapped collection.
4116
+ /** @description List of connector-specific usernames denied access to create new guest
4117
+ * collections on this mapped collection.
4170
4118
  * */
4171
4119
  sharing_users_deny?: string[] | null;
4172
4120
  /**
@@ -4193,11 +4141,10 @@ export interface components {
4193
4141
  * message may be up to 256 characters long.
4194
4142
  * */
4195
4143
  user_message?: string | null;
4196
- /** @description Link to additional messaging for clients to display to users
4197
- * when interacting with this endpoint, linked to an
4198
- * HTTP or HTTPS URL. For guest collections, this property is
4199
- * read-only and is the same as the value of its related mapped
4200
- * collection.
4144
+ /** @description Link to additional messaging for clients to display to users when
4145
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
4146
+ * guest collections, this property is read-only and is the same as the
4147
+ * value of its related mapped collection.
4201
4148
  * */
4202
4149
  user_message_link?: string | null;
4203
4150
  };
@@ -4251,36 +4198,40 @@ export interface components {
4251
4198
  * @enum {string}
4252
4199
  */
4253
4200
  DATA_TYPE: "collection#1.11.0";
4254
- /** @description Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value. */
4201
+ /** @description Length of time that guest collection permissions are valid. Only
4202
+ * settable on HA guest collections and HA mapped collections and used
4203
+ * by guest collections attached to it. When set on both the mapped and
4204
+ * guest collections, the lesser value is in effect. Set to null to
4205
+ * delete any previously set value.
4206
+ * */
4255
4207
  acl_expiration_mins?: number | null;
4256
4208
  /** @description Flag indicating if this Collection allows users to create guest
4257
- * collections on it. This is always false if this is a guest
4258
- * collection. If this is changed to false on a mapped collection with
4259
- * associated guest collections, those collections will no longer be
4260
- * accessible.
4209
+ * collections on it. This is always false if this is a guest collection.
4210
+ * If this is changed to false on a mapped collection with associated
4211
+ * guest collections, those collections will no longer be accessible.
4261
4212
  * */
4262
4213
  allow_guest_collections?: boolean;
4263
4214
  /** @description Timeout (in minutes) during which a user is required to have
4264
4215
  * authenticated in a session to access this storage gateway.
4265
4216
  * */
4266
4217
  readonly authentication_timeout_mins?: number;
4267
- /** @description Path to be interpreted as the base path when creating a new
4268
- * collection. It is interpreted differently depending on the
4269
- * collection type being created. For a mapped collection, this is an
4270
- * absolute path on the storage system named by the
4271
- * storage_gateway_id. For a guest collection, this is a relative
4272
- * path relative to the value of the `root_path` attribute on the
4273
- * mapped collection with the same Id as the `mapped_collection_id`
4274
- * property. This may not be changed once the collection is created.
4218
+ /** @description Path to be interpreted as the base path when creating a new collection.
4219
+ * It is interpreted differently depending on the collection type being
4220
+ * created. For a mapped collection, this is an absolute path on the
4221
+ * storage system named by the storage_gateway_id. For a guest collection,
4222
+ * this is a relative path relative to the value of the `root_path`
4223
+ * attribute on the mapped collection with the same Id as the
4224
+ * `mapped_collection_id` property. This may not be changed once the
4225
+ * collection is created.
4275
4226
  *
4276
4227
  * Support for `~` was added in API version 1.21.0.
4277
4228
  * */
4278
4229
  collection_base_path: string;
4279
4230
  /**
4280
- * @description Type of collection. A `mapped` collection requires an account on
4281
- * the system to access the administrator-defined collection. A
4282
- * `guest` collection allows users to share access to their data on a
4283
- * Storage Gateway by registering a credential with the GCS Manager.
4231
+ * @description Type of collection. A `mapped` collection requires an account on the
4232
+ * system to access the administrator-defined collection. A `guest`
4233
+ * collection allows users to share access to their data on a Storage
4234
+ * Gateway by registering a credential with the GCS Manager.
4284
4235
  *
4285
4236
  * @enum {string}
4286
4237
  */
@@ -4290,12 +4241,13 @@ export interface components {
4290
4241
  * @description Id of the connector type that is used by this collection.
4291
4242
  */
4292
4243
  readonly connector_id?: string;
4293
- /** @description Email address of the support contact for this collection. This is visible
4294
- * to end users so that they may contact your organization for support.
4244
+ /** @description Email address of the support contact for this collection. This is
4245
+ * visible to end users so that they may contact your organization for
4246
+ * support.
4295
4247
  * */
4296
4248
  contact_email?: string | null;
4297
- /** @description Other non-email contact information for the collection, e.g. phone and
4298
- * mailing address. This is visible to end users for support.
4249
+ /** @description Other non-email contact information for the collection, e.g. phone
4250
+ * and mailing address. This is visible to end users for support.
4299
4251
  * */
4300
4252
  contact_info?: string | null;
4301
4253
  /**
@@ -4307,11 +4259,10 @@ export interface components {
4307
4259
  * the special string `$USER` which is evaluated at access time to be
4308
4260
  * the connector-specific username accessing the data.
4309
4261
  *
4310
- * If the collection is mapped collection with a
4311
- * **collection_base_path** value of `/`, this value can also begin
4312
- * with the values `/~/` and `$HOME`, which are replaced by the user's
4313
- * home directory, or `/` if the connector does not support the
4314
- * concept of a home directory.
4262
+ * If the collection is mapped collection with a **collection_base_path**
4263
+ * value of `/`, this value can also begin with the values `/~/` and
4264
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
4265
+ * the connector does not support the concept of a home directory.
4315
4266
  * */
4316
4267
  default_directory?: string;
4317
4268
  /** @description If set to true, this collection can not be deleted. This property
@@ -4321,15 +4272,14 @@ export interface components {
4321
4272
  delete_protected?: boolean;
4322
4273
  /** @description Flag indicating that this collection has been deleted */
4323
4274
  readonly deleted?: boolean;
4324
- /** @description Department within organization that runs the server(s).
4325
- * Searchable. Optional. Unicode string, max 1024
4326
- * characters, no new lines.
4275
+ /** @description Department within organization that runs the server(s). Searchable.
4276
+ * Optional. Unicode string, max 1024 characters, no new lines.
4327
4277
  * */
4328
4278
  department?: string | null;
4329
4279
  /** @description A description of the collection. */
4330
4280
  description?: string | null;
4331
- /** @description Flag indicating if guest collections on this mapped collection
4332
- * allow anonymous write permissions or not. This flag is always true for high
4281
+ /** @description Flag indicating if guest collections on this mapped collection allow
4282
+ * anonymous write permissions or not. This flag is always true for high
4333
4283
  * assurance collections. For non-high assurance mapped collections, the
4334
4284
  * default value is false.
4335
4285
  * */
@@ -4338,15 +4288,15 @@ export interface components {
4338
4288
  * checksums, needed for the verify_checksum option of transfer.
4339
4289
  * */
4340
4290
  disable_verify?: boolean;
4341
- /** @description Friendly name for the collection. Unicode string, max 128
4342
- * characters, no new lines (`\r` or `\n`).
4291
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
4292
+ * no new lines (`\r` or `\n`).
4343
4293
  * */
4344
4294
  display_name: string;
4345
4295
  domain?: components["schemas"]["Domain"];
4346
4296
  /** @description DNS name of the virtual host serving this collection. For mapped
4347
- * collections which do not have a custom domain, this may be specified as
4348
- * part of the input document to create the collection, otherwise this is
4349
- * a read-only property. When included in the input, the name is
4297
+ * collections which do not have a custom domain, this may be specified
4298
+ * as part of the input document to create the collection, otherwise this
4299
+ * is a read-only property. When included in the input, the name is
4350
4300
  * restricted to be a subdomain of the endpoint, and the input name label
4351
4301
  * may not start with `m-` or `g-`.
4352
4302
  * */
@@ -4362,8 +4312,7 @@ export interface components {
4362
4312
  *
4363
4313
  * __New in v5.4.17__: If a mapped collection forces encryption, all
4364
4314
  * of its guest collections must as well. If this option is used on a
4365
- * mapped collection, the value is propagated to its guest
4366
- * collections.
4315
+ * mapped collection, the value is propagated to its guest collections.
4367
4316
  * */
4368
4317
  force_encryption?: boolean;
4369
4318
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -4387,8 +4336,8 @@ export interface components {
4387
4336
  readonly https_url?: string;
4388
4337
  /**
4389
4338
  * Format: uuid
4390
- * @description Unique identifier for this collection. This is assigned
4391
- * by the GCS manager when creating a collection.
4339
+ * @description Unique identifier for this collection. This is assigned by the GCS
4340
+ * manager when creating a collection.
4392
4341
  *
4393
4342
  */
4394
4343
  readonly id?: string;
@@ -4401,9 +4350,8 @@ export interface components {
4401
4350
  identity_id?: string;
4402
4351
  /** @description Link to a web page with more information about the collection */
4403
4352
  info_link?: string | null;
4404
- /** @description List of search keywords for the
4405
- * endpoint. Optional. Unicode string, max 1024
4406
- * characters total across all strings.
4353
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
4354
+ * max 1024 characters total across all strings.
4407
4355
  * */
4408
4356
  keywords?: string[];
4409
4357
  /**
@@ -4459,8 +4407,8 @@ export interface components {
4459
4407
  * collections on this mapped collection.
4460
4408
  * */
4461
4409
  sharing_users_allow?: string[] | null;
4462
- /** @description List of connector-specific usernames denied access to
4463
- * create new guest collections on this mapped collection.
4410
+ /** @description List of connector-specific usernames denied access to create new guest
4411
+ * collections on this mapped collection.
4464
4412
  * */
4465
4413
  sharing_users_deny?: string[] | null;
4466
4414
  /**
@@ -4487,11 +4435,10 @@ export interface components {
4487
4435
  * message may be up to 256 characters long.
4488
4436
  * */
4489
4437
  user_message?: string | null;
4490
- /** @description Link to additional messaging for clients to display to users
4491
- * when interacting with this endpoint, linked to an
4492
- * HTTP or HTTPS URL. For guest collections, this property is
4493
- * read-only and is the same as the value of its related mapped
4494
- * collection.
4438
+ /** @description Link to additional messaging for clients to display to users when
4439
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
4440
+ * guest collections, this property is read-only and is the same as the
4441
+ * value of its related mapped collection.
4495
4442
  * */
4496
4443
  user_message_link?: string | null;
4497
4444
  };
@@ -4548,36 +4495,40 @@ export interface components {
4548
4495
  * @enum {string}
4549
4496
  */
4550
4497
  DATA_TYPE: "collection#1.12.0";
4551
- /** @description Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value. */
4498
+ /** @description Length of time that guest collection permissions are valid. Only
4499
+ * settable on HA guest collections and HA mapped collections and used
4500
+ * by guest collections attached to it. When set on both the mapped and
4501
+ * guest collections, the lesser value is in effect. Set to null to
4502
+ * delete any previously set value.
4503
+ * */
4552
4504
  acl_expiration_mins?: number | null;
4553
4505
  /** @description Flag indicating if this Collection allows users to create guest
4554
- * collections on it. This is always false if this is a guest
4555
- * collection. If this is changed to false on a mapped collection with
4556
- * associated guest collections, those collections will no longer be
4557
- * accessible.
4506
+ * collections on it. This is always false if this is a guest collection.
4507
+ * If this is changed to false on a mapped collection with associated
4508
+ * guest collections, those collections will no longer be accessible.
4558
4509
  * */
4559
4510
  allow_guest_collections?: boolean;
4560
4511
  /** @description Timeout (in minutes) during which a user is required to have
4561
4512
  * authenticated in a session to access this storage gateway.
4562
4513
  * */
4563
4514
  readonly authentication_timeout_mins?: number;
4564
- /** @description Path to be interpreted as the base path when creating a new
4565
- * collection. It is interpreted differently depending on the
4566
- * collection type being created. For a mapped collection, this is an
4567
- * absolute path on the storage system named by the
4568
- * storage_gateway_id. For a guest collection, this is a relative
4569
- * path relative to the value of the `root_path` attribute on the
4570
- * mapped collection with the same Id as the `mapped_collection_id`
4571
- * property. This may not be changed once the collection is created.
4515
+ /** @description Path to be interpreted as the base path when creating a new collection.
4516
+ * It is interpreted differently depending on the collection type being
4517
+ * created. For a mapped collection, this is an absolute path on the
4518
+ * storage system named by the storage_gateway_id. For a guest collection,
4519
+ * this is a relative path relative to the value of the `root_path`
4520
+ * attribute on the mapped collection with the same Id as the
4521
+ * `mapped_collection_id` property. This may not be changed once the
4522
+ * collection is created.
4572
4523
  *
4573
4524
  * Support for `~` was added in API version 1.21.0.
4574
4525
  * */
4575
4526
  collection_base_path: string;
4576
4527
  /**
4577
- * @description Type of collection. A `mapped` collection requires an account on
4578
- * the system to access the administrator-defined collection. A
4579
- * `guest` collection allows users to share access to their data on a
4580
- * Storage Gateway by registering a credential with the GCS Manager.
4528
+ * @description Type of collection. A `mapped` collection requires an account on the
4529
+ * system to access the administrator-defined collection. A `guest`
4530
+ * collection allows users to share access to their data on a Storage
4531
+ * Gateway by registering a credential with the GCS Manager.
4581
4532
  *
4582
4533
  * @enum {string}
4583
4534
  */
@@ -4587,12 +4538,13 @@ export interface components {
4587
4538
  * @description Id of the connector type that is used by this collection.
4588
4539
  */
4589
4540
  readonly connector_id?: string;
4590
- /** @description Email address of the support contact for this collection. This is visible
4591
- * to end users so that they may contact your organization for support.
4541
+ /** @description Email address of the support contact for this collection. This is
4542
+ * visible to end users so that they may contact your organization for
4543
+ * support.
4592
4544
  * */
4593
4545
  contact_email?: string | null;
4594
- /** @description Other non-email contact information for the collection, e.g. phone and
4595
- * mailing address. This is visible to end users for support.
4546
+ /** @description Other non-email contact information for the collection, e.g. phone
4547
+ * and mailing address. This is visible to end users for support.
4596
4548
  * */
4597
4549
  contact_info?: string | null;
4598
4550
  /**
@@ -4604,11 +4556,10 @@ export interface components {
4604
4556
  * the special string `$USER` which is evaluated at access time to be
4605
4557
  * the connector-specific username accessing the data.
4606
4558
  *
4607
- * If the collection is mapped collection with a
4608
- * **collection_base_path** value of `/`, this value can also begin
4609
- * with the values `/~/` and `$HOME`, which are replaced by the user's
4610
- * home directory, or `/` if the connector does not support the
4611
- * concept of a home directory.
4559
+ * If the collection is mapped collection with a **collection_base_path**
4560
+ * value of `/`, this value can also begin with the values `/~/` and
4561
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
4562
+ * the connector does not support the concept of a home directory.
4612
4563
  * */
4613
4564
  default_directory?: string;
4614
4565
  /** @description If set to true, this collection can not be deleted. This property
@@ -4618,15 +4569,14 @@ export interface components {
4618
4569
  delete_protected?: boolean;
4619
4570
  /** @description Flag indicating that this collection has been deleted */
4620
4571
  readonly deleted?: boolean;
4621
- /** @description Department within organization that runs the server(s).
4622
- * Searchable. Optional. Unicode string, max 1024
4623
- * characters, no new lines.
4572
+ /** @description Department within organization that runs the server(s). Searchable.
4573
+ * Optional. Unicode string, max 1024 characters, no new lines.
4624
4574
  * */
4625
4575
  department?: string | null;
4626
4576
  /** @description A description of the collection. */
4627
4577
  description?: string | null;
4628
- /** @description Flag indicating if guest collections on this mapped collection
4629
- * allow anonymous write permissions or not. This flag is always true for high
4578
+ /** @description Flag indicating if guest collections on this mapped collection allow
4579
+ * anonymous write permissions or not. This flag is always true for high
4630
4580
  * assurance collections. For non-high assurance mapped collections, the
4631
4581
  * default value is false.
4632
4582
  * */
@@ -4635,15 +4585,15 @@ export interface components {
4635
4585
  * checksums, needed for the verify_checksum option of transfer.
4636
4586
  * */
4637
4587
  disable_verify?: boolean;
4638
- /** @description Friendly name for the collection. Unicode string, max 128
4639
- * characters, no new lines (`\r` or `\n`).
4588
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
4589
+ * no new lines (`\r` or `\n`).
4640
4590
  * */
4641
4591
  display_name: string;
4642
4592
  domain?: components["schemas"]["Domain"];
4643
4593
  /** @description DNS name of the virtual host serving this collection. For mapped
4644
- * collections which do not have a custom domain, this may be specified as
4645
- * part of the input document to create the collection, otherwise this is
4646
- * a read-only property. When included in the input, the name is
4594
+ * collections which do not have a custom domain, this may be specified
4595
+ * as part of the input document to create the collection, otherwise this
4596
+ * is a read-only property. When included in the input, the name is
4647
4597
  * restricted to be a subdomain of the endpoint, and the input name label
4648
4598
  * may not start with `m-` or `g-`.
4649
4599
  * */
@@ -4659,8 +4609,7 @@ export interface components {
4659
4609
  *
4660
4610
  * __New in v5.4.17__: If a mapped collection forces encryption, all
4661
4611
  * of its guest collections must as well. If this option is used on a
4662
- * mapped collection, the value is propagated to its guest
4663
- * collections.
4612
+ * mapped collection, the value is propagated to its guest collections.
4664
4613
  * */
4665
4614
  force_encryption?: boolean;
4666
4615
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -4684,8 +4633,8 @@ export interface components {
4684
4633
  readonly https_url?: string;
4685
4634
  /**
4686
4635
  * Format: uuid
4687
- * @description Unique identifier for this collection. This is assigned
4688
- * by the GCS manager when creating a collection.
4636
+ * @description Unique identifier for this collection. This is assigned by the GCS
4637
+ * manager when creating a collection.
4689
4638
  *
4690
4639
  */
4691
4640
  readonly id?: string;
@@ -4698,9 +4647,8 @@ export interface components {
4698
4647
  identity_id?: string;
4699
4648
  /** @description Link to a web page with more information about the collection */
4700
4649
  info_link?: string | null;
4701
- /** @description List of search keywords for the
4702
- * endpoint. Optional. Unicode string, max 1024
4703
- * characters total across all strings.
4650
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
4651
+ * max 1024 characters total across all strings.
4704
4652
  * */
4705
4653
  keywords?: string[];
4706
4654
  /**
@@ -4740,11 +4688,11 @@ export interface components {
4740
4688
  * */
4741
4689
  readonly require_mfa?: boolean;
4742
4690
  /**
4743
- * @description Flag indicating whether all data transfers to and from this
4744
- * collection require the remote collection be HA. This can only be
4745
- * assigned on high assurance mapped collections. High assurance
4746
- * guest collections inherit the restriction from their associated
4747
- * mapped collections. This may be set to null to disable this feature.
4691
+ * @description Flag indicating whether all data transfers to and from this collection
4692
+ * require the remote collection be HA. This can only be assigned on high
4693
+ * assurance mapped collections. High assurance guest collections inherit
4694
+ * the restriction from their associated mapped collections. This may be
4695
+ * set to null to disable this feature.
4748
4696
  *
4749
4697
  * If a restriction is in place for a collection, then HTTPS access to
4750
4698
  * it is disabled.
@@ -4769,8 +4717,8 @@ export interface components {
4769
4717
  * collections on this mapped collection.
4770
4718
  * */
4771
4719
  sharing_users_allow?: string[] | null;
4772
- /** @description List of connector-specific usernames denied access to
4773
- * create new guest collections on this mapped collection.
4720
+ /** @description List of connector-specific usernames denied access to create new guest
4721
+ * collections on this mapped collection.
4774
4722
  * */
4775
4723
  sharing_users_deny?: string[] | null;
4776
4724
  /**
@@ -4797,11 +4745,10 @@ export interface components {
4797
4745
  * message may be up to 256 characters long.
4798
4746
  * */
4799
4747
  user_message?: string | null;
4800
- /** @description Link to additional messaging for clients to display to users
4801
- * when interacting with this endpoint, linked to an
4802
- * HTTP or HTTPS URL. For guest collections, this property is
4803
- * read-only and is the same as the value of its related mapped
4804
- * collection.
4748
+ /** @description Link to additional messaging for clients to display to users when
4749
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
4750
+ * guest collections, this property is read-only and is the same as the
4751
+ * value of its related mapped collection.
4805
4752
  * */
4806
4753
  user_message_link?: string | null;
4807
4754
  };
@@ -4861,13 +4808,17 @@ export interface components {
4861
4808
  * @enum {string}
4862
4809
  */
4863
4810
  DATA_TYPE: "collection#1.13.0";
4864
- /** @description Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value. */
4811
+ /** @description Length of time that guest collection permissions are valid. Only
4812
+ * settable on HA guest collections and HA mapped collections and used
4813
+ * by guest collections attached to it. When set on both the mapped and
4814
+ * guest collections, the lesser value is in effect. Set to null to
4815
+ * delete any previously set value.
4816
+ * */
4865
4817
  acl_expiration_mins?: number | null;
4866
4818
  /** @description Flag indicating if this Collection allows users to create guest
4867
- * collections on it. This is always false if this is a guest
4868
- * collection. If this is changed to false on a mapped collection with
4869
- * associated guest collections, those collections will no longer be
4870
- * accessible.
4819
+ * collections on it. This is always false if this is a guest collection.
4820
+ * If this is changed to false on a mapped collection with associated
4821
+ * guest collections, those collections will no longer be accessible.
4871
4822
  * */
4872
4823
  allow_guest_collections?: boolean;
4873
4824
  /** @description Timeout (in minutes) during which a user is required to have
@@ -4880,23 +4831,23 @@ export interface components {
4880
4831
  * for the mapped collection. Defaults to disabled.
4881
4832
  * */
4882
4833
  auto_delete_timeout?: number | null;
4883
- /** @description Path to be interpreted as the base path when creating a new
4884
- * collection. It is interpreted differently depending on the
4885
- * collection type being created. For a mapped collection, this is an
4886
- * absolute path on the storage system named by the
4887
- * storage_gateway_id. For a guest collection, this is a relative
4888
- * path relative to the value of the `root_path` attribute on the
4889
- * mapped collection with the same Id as the `mapped_collection_id`
4890
- * property. This may not be changed once the collection is created.
4834
+ /** @description Path to be interpreted as the base path when creating a new collection.
4835
+ * It is interpreted differently depending on the collection type being
4836
+ * created. For a mapped collection, this is an absolute path on the
4837
+ * storage system named by the storage_gateway_id. For a guest collection,
4838
+ * this is a relative path relative to the value of the `root_path`
4839
+ * attribute on the mapped collection with the same Id as the
4840
+ * `mapped_collection_id` property. This may not be changed once the
4841
+ * collection is created.
4891
4842
  *
4892
4843
  * Support for `~` was added in API version 1.21.0.
4893
4844
  * */
4894
4845
  collection_base_path: string;
4895
4846
  /**
4896
- * @description Type of collection. A `mapped` collection requires an account on
4897
- * the system to access the administrator-defined collection. A
4898
- * `guest` collection allows users to share access to their data on a
4899
- * Storage Gateway by registering a credential with the GCS Manager.
4847
+ * @description Type of collection. A `mapped` collection requires an account on the
4848
+ * system to access the administrator-defined collection. A `guest`
4849
+ * collection allows users to share access to their data on a Storage
4850
+ * Gateway by registering a credential with the GCS Manager.
4900
4851
  *
4901
4852
  * @enum {string}
4902
4853
  */
@@ -4906,12 +4857,13 @@ export interface components {
4906
4857
  * @description Id of the connector type that is used by this collection.
4907
4858
  */
4908
4859
  readonly connector_id?: string;
4909
- /** @description Email address of the support contact for this collection. This is visible
4910
- * to end users so that they may contact your organization for support.
4860
+ /** @description Email address of the support contact for this collection. This is
4861
+ * visible to end users so that they may contact your organization for
4862
+ * support.
4911
4863
  * */
4912
4864
  contact_email?: string | null;
4913
- /** @description Other non-email contact information for the collection, e.g. phone and
4914
- * mailing address. This is visible to end users for support.
4865
+ /** @description Other non-email contact information for the collection, e.g. phone
4866
+ * and mailing address. This is visible to end users for support.
4915
4867
  * */
4916
4868
  contact_info?: string | null;
4917
4869
  /**
@@ -4923,11 +4875,10 @@ export interface components {
4923
4875
  * the special string `$USER` which is evaluated at access time to be
4924
4876
  * the connector-specific username accessing the data.
4925
4877
  *
4926
- * If the collection is mapped collection with a
4927
- * **collection_base_path** value of `/`, this value can also begin
4928
- * with the values `/~/` and `$HOME`, which are replaced by the user's
4929
- * home directory, or `/` if the connector does not support the
4930
- * concept of a home directory.
4878
+ * If the collection is mapped collection with a **collection_base_path**
4879
+ * value of `/`, this value can also begin with the values `/~/` and
4880
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
4881
+ * the connector does not support the concept of a home directory.
4931
4882
  * */
4932
4883
  default_directory?: string;
4933
4884
  /** @description If set to true, this collection can not be deleted. This property
@@ -4937,15 +4888,14 @@ export interface components {
4937
4888
  delete_protected?: boolean;
4938
4889
  /** @description Flag indicating that this collection has been deleted */
4939
4890
  readonly deleted?: boolean;
4940
- /** @description Department within organization that runs the server(s).
4941
- * Searchable. Optional. Unicode string, max 1024
4942
- * characters, no new lines.
4891
+ /** @description Department within organization that runs the server(s). Searchable.
4892
+ * Optional. Unicode string, max 1024 characters, no new lines.
4943
4893
  * */
4944
4894
  department?: string | null;
4945
4895
  /** @description A description of the collection. */
4946
4896
  description?: string | null;
4947
- /** @description Flag indicating if guest collections on this mapped collection
4948
- * allow anonymous write permissions or not. This flag is always true for high
4897
+ /** @description Flag indicating if guest collections on this mapped collection allow
4898
+ * anonymous write permissions or not. This flag is always true for high
4949
4899
  * assurance collections. For non-high assurance mapped collections, the
4950
4900
  * default value is false.
4951
4901
  * */
@@ -4954,15 +4904,15 @@ export interface components {
4954
4904
  * checksums, needed for the verify_checksum option of transfer.
4955
4905
  * */
4956
4906
  disable_verify?: boolean;
4957
- /** @description Friendly name for the collection. Unicode string, max 128
4958
- * characters, no new lines (`\r` or `\n`).
4907
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
4908
+ * no new lines (`\r` or `\n`).
4959
4909
  * */
4960
4910
  display_name: string;
4961
4911
  domain?: components["schemas"]["Domain"];
4962
4912
  /** @description DNS name of the virtual host serving this collection. For mapped
4963
- * collections which do not have a custom domain, this may be specified as
4964
- * part of the input document to create the collection, otherwise this is
4965
- * a read-only property. When included in the input, the name is
4913
+ * collections which do not have a custom domain, this may be specified
4914
+ * as part of the input document to create the collection, otherwise this
4915
+ * is a read-only property. When included in the input, the name is
4966
4916
  * restricted to be a subdomain of the endpoint, and the input name label
4967
4917
  * may not start with `m-` or `g-`.
4968
4918
  * */
@@ -4978,8 +4928,7 @@ export interface components {
4978
4928
  *
4979
4929
  * __New in v5.4.17__: If a mapped collection forces encryption, all
4980
4930
  * of its guest collections must as well. If this option is used on a
4981
- * mapped collection, the value is propagated to its guest
4982
- * collections.
4931
+ * mapped collection, the value is propagated to its guest collections.
4983
4932
  * */
4984
4933
  force_encryption?: boolean;
4985
4934
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -5003,8 +4952,8 @@ export interface components {
5003
4952
  readonly https_url?: string;
5004
4953
  /**
5005
4954
  * Format: uuid
5006
- * @description Unique identifier for this collection. This is assigned
5007
- * by the GCS manager when creating a collection.
4955
+ * @description Unique identifier for this collection. This is assigned by the GCS
4956
+ * manager when creating a collection.
5008
4957
  *
5009
4958
  */
5010
4959
  readonly id?: string;
@@ -5017,9 +4966,8 @@ export interface components {
5017
4966
  identity_id?: string;
5018
4967
  /** @description Link to a web page with more information about the collection */
5019
4968
  info_link?: string | null;
5020
- /** @description List of search keywords for the
5021
- * endpoint. Optional. Unicode string, max 1024
5022
- * characters total across all strings.
4969
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
4970
+ * max 1024 characters total across all strings.
5023
4971
  * */
5024
4972
  keywords?: string[];
5025
4973
  /**
@@ -5059,11 +5007,11 @@ export interface components {
5059
5007
  * */
5060
5008
  readonly require_mfa?: boolean;
5061
5009
  /**
5062
- * @description Flag indicating whether all data transfers to and from this
5063
- * collection require the remote collection be HA. This can only be
5064
- * assigned on high assurance mapped collections. High assurance
5065
- * guest collections inherit the restriction from their associated
5066
- * mapped collections. This may be set to null to disable this feature.
5010
+ * @description Flag indicating whether all data transfers to and from this collection
5011
+ * require the remote collection be HA. This can only be assigned on high
5012
+ * assurance mapped collections. High assurance guest collections inherit
5013
+ * the restriction from their associated mapped collections. This may be
5014
+ * set to null to disable this feature.
5067
5015
  *
5068
5016
  * If a restriction is in place for a collection, then HTTPS access to
5069
5017
  * it is disabled.
@@ -5088,8 +5036,8 @@ export interface components {
5088
5036
  * collections on this mapped collection.
5089
5037
  * */
5090
5038
  sharing_users_allow?: string[] | null;
5091
- /** @description List of connector-specific usernames denied access to
5092
- * create new guest collections on this mapped collection.
5039
+ /** @description List of connector-specific usernames denied access to create new guest
5040
+ * collections on this mapped collection.
5093
5041
  * */
5094
5042
  sharing_users_deny?: string[] | null;
5095
5043
  /** @description Flag indicating whether the guest collection is subject to automatic
@@ -5121,11 +5069,10 @@ export interface components {
5121
5069
  * message may be up to 256 characters long.
5122
5070
  * */
5123
5071
  user_message?: string | null;
5124
- /** @description Link to additional messaging for clients to display to users
5125
- * when interacting with this endpoint, linked to an
5126
- * HTTP or HTTPS URL. For guest collections, this property is
5127
- * read-only and is the same as the value of its related mapped
5128
- * collection.
5072
+ /** @description Link to additional messaging for clients to display to users when
5073
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
5074
+ * guest collections, this property is read-only and is the same as the
5075
+ * value of its related mapped collection.
5129
5076
  * */
5130
5077
  user_message_link?: string | null;
5131
5078
  };
@@ -5193,14 +5140,18 @@ export interface components {
5193
5140
  * @enum {string}
5194
5141
  */
5195
5142
  DATA_TYPE: "collection#1.14.0";
5196
- /** @description Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value. */
5143
+ /** @description Length of time that guest collection permissions are valid. Only
5144
+ * settable on HA guest collections and HA mapped collections and used
5145
+ * by guest collections attached to it. When set on both the mapped and
5146
+ * guest collections, the lesser value is in effect. Set to null to
5147
+ * delete any previously set value.
5148
+ * */
5197
5149
  acl_expiration_mins?: number | null;
5198
5150
  activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
5199
5151
  /** @description Flag indicating if this Collection allows users to create guest
5200
- * collections on it. This is always false if this is a guest
5201
- * collection. If this is changed to false on a mapped collection with
5202
- * associated guest collections, those collections will no longer be
5203
- * accessible.
5152
+ * collections on it. This is always false if this is a guest collection.
5153
+ * If this is changed to false on a mapped collection with associated
5154
+ * guest collections, those collections will no longer be accessible.
5204
5155
  * */
5205
5156
  allow_guest_collections?: boolean;
5206
5157
  /** @description Timeout (in minutes) during which a user is required to have
@@ -5213,23 +5164,23 @@ export interface components {
5213
5164
  * for the mapped collection. Defaults to disabled.
5214
5165
  * */
5215
5166
  auto_delete_timeout?: number | null;
5216
- /** @description Path to be interpreted as the base path when creating a new
5217
- * collection. It is interpreted differently depending on the
5218
- * collection type being created. For a mapped collection, this is an
5219
- * absolute path on the storage system named by the
5220
- * storage_gateway_id. For a guest collection, this is a relative
5221
- * path relative to the value of the `root_path` attribute on the
5222
- * mapped collection with the same Id as the `mapped_collection_id`
5223
- * property. This may not be changed once the collection is created.
5167
+ /** @description Path to be interpreted as the base path when creating a new collection.
5168
+ * It is interpreted differently depending on the collection type being
5169
+ * created. For a mapped collection, this is an absolute path on the
5170
+ * storage system named by the storage_gateway_id. For a guest collection,
5171
+ * this is a relative path relative to the value of the `root_path`
5172
+ * attribute on the mapped collection with the same Id as the
5173
+ * `mapped_collection_id` property. This may not be changed once the
5174
+ * collection is created.
5224
5175
  *
5225
5176
  * Support for `~` was added in API version 1.21.0.
5226
5177
  * */
5227
5178
  collection_base_path: string;
5228
5179
  /**
5229
- * @description Type of collection. A `mapped` collection requires an account on
5230
- * the system to access the administrator-defined collection. A
5231
- * `guest` collection allows users to share access to their data on a
5232
- * Storage Gateway by registering a credential with the GCS Manager.
5180
+ * @description Type of collection. A `mapped` collection requires an account on the
5181
+ * system to access the administrator-defined collection. A `guest`
5182
+ * collection allows users to share access to their data on a Storage
5183
+ * Gateway by registering a credential with the GCS Manager.
5233
5184
  *
5234
5185
  * @enum {string}
5235
5186
  */
@@ -5239,12 +5190,13 @@ export interface components {
5239
5190
  * @description Id of the connector type that is used by this collection.
5240
5191
  */
5241
5192
  readonly connector_id?: string;
5242
- /** @description Email address of the support contact for this collection. This is visible
5243
- * to end users so that they may contact your organization for support.
5193
+ /** @description Email address of the support contact for this collection. This is
5194
+ * visible to end users so that they may contact your organization for
5195
+ * support.
5244
5196
  * */
5245
5197
  contact_email?: string | null;
5246
- /** @description Other non-email contact information for the collection, e.g. phone and
5247
- * mailing address. This is visible to end users for support.
5198
+ /** @description Other non-email contact information for the collection, e.g. phone
5199
+ * and mailing address. This is visible to end users for support.
5248
5200
  * */
5249
5201
  contact_info?: string | null;
5250
5202
  /**
@@ -5256,11 +5208,10 @@ export interface components {
5256
5208
  * the special string `$USER` which is evaluated at access time to be
5257
5209
  * the connector-specific username accessing the data.
5258
5210
  *
5259
- * If the collection is mapped collection with a
5260
- * **collection_base_path** value of `/`, this value can also begin
5261
- * with the values `/~/` and `$HOME`, which are replaced by the user's
5262
- * home directory, or `/` if the connector does not support the
5263
- * concept of a home directory.
5211
+ * If the collection is mapped collection with a **collection_base_path**
5212
+ * value of `/`, this value can also begin with the values `/~/` and
5213
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
5214
+ * the connector does not support the concept of a home directory.
5264
5215
  * */
5265
5216
  default_directory?: string;
5266
5217
  /** @description If set to true, this collection can not be deleted. This property
@@ -5270,15 +5221,14 @@ export interface components {
5270
5221
  delete_protected?: boolean;
5271
5222
  /** @description Flag indicating that this collection has been deleted */
5272
5223
  readonly deleted?: boolean;
5273
- /** @description Department within organization that runs the server(s).
5274
- * Searchable. Optional. Unicode string, max 1024
5275
- * characters, no new lines.
5224
+ /** @description Department within organization that runs the server(s). Searchable.
5225
+ * Optional. Unicode string, max 1024 characters, no new lines.
5276
5226
  * */
5277
5227
  department?: string | null;
5278
5228
  /** @description A description of the collection. */
5279
5229
  description?: string | null;
5280
- /** @description Flag indicating if guest collections on this mapped collection
5281
- * allow anonymous write permissions or not. This flag is always true for high
5230
+ /** @description Flag indicating if guest collections on this mapped collection allow
5231
+ * anonymous write permissions or not. This flag is always true for high
5282
5232
  * assurance collections. For non-high assurance mapped collections, the
5283
5233
  * default value is false.
5284
5234
  * */
@@ -5287,15 +5237,15 @@ export interface components {
5287
5237
  * checksums, needed for the verify_checksum option of transfer.
5288
5238
  * */
5289
5239
  disable_verify?: boolean;
5290
- /** @description Friendly name for the collection. Unicode string, max 128
5291
- * characters, no new lines (`\r` or `\n`).
5240
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
5241
+ * no new lines (`\r` or `\n`).
5292
5242
  * */
5293
5243
  display_name: string;
5294
5244
  domain?: components["schemas"]["Domain"];
5295
5245
  /** @description DNS name of the virtual host serving this collection. For mapped
5296
- * collections which do not have a custom domain, this may be specified as
5297
- * part of the input document to create the collection, otherwise this is
5298
- * a read-only property. When included in the input, the name is
5246
+ * collections which do not have a custom domain, this may be specified
5247
+ * as part of the input document to create the collection, otherwise this
5248
+ * is a read-only property. When included in the input, the name is
5299
5249
  * restricted to be a subdomain of the endpoint, and the input name label
5300
5250
  * may not start with `m-` or `g-`.
5301
5251
  * */
@@ -5311,8 +5261,7 @@ export interface components {
5311
5261
  *
5312
5262
  * __New in v5.4.17__: If a mapped collection forces encryption, all
5313
5263
  * of its guest collections must as well. If this option is used on a
5314
- * mapped collection, the value is propagated to its guest
5315
- * collections.
5264
+ * mapped collection, the value is propagated to its guest collections.
5316
5265
  * */
5317
5266
  force_encryption?: boolean;
5318
5267
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -5336,8 +5285,8 @@ export interface components {
5336
5285
  readonly https_url?: string;
5337
5286
  /**
5338
5287
  * Format: uuid
5339
- * @description Unique identifier for this collection. This is assigned
5340
- * by the GCS manager when creating a collection.
5288
+ * @description Unique identifier for this collection. This is assigned by the GCS
5289
+ * manager when creating a collection.
5341
5290
  *
5342
5291
  */
5343
5292
  readonly id?: string;
@@ -5350,9 +5299,8 @@ export interface components {
5350
5299
  identity_id?: string;
5351
5300
  /** @description Link to a web page with more information about the collection */
5352
5301
  info_link?: string | null;
5353
- /** @description List of search keywords for the
5354
- * endpoint. Optional. Unicode string, max 1024
5355
- * characters total across all strings.
5302
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
5303
+ * max 1024 characters total across all strings.
5356
5304
  * */
5357
5305
  keywords?: string[];
5358
5306
  /**
@@ -5392,11 +5340,11 @@ export interface components {
5392
5340
  * */
5393
5341
  readonly require_mfa?: boolean;
5394
5342
  /**
5395
- * @description Flag indicating whether all data transfers to and from this
5396
- * collection require the remote collection be HA. This can only be
5397
- * assigned on high assurance mapped collections. High assurance
5398
- * guest collections inherit the restriction from their associated
5399
- * mapped collections. This may be set to null to disable this feature.
5343
+ * @description Flag indicating whether all data transfers to and from this collection
5344
+ * require the remote collection be HA. This can only be assigned on high
5345
+ * assurance mapped collections. High assurance guest collections inherit
5346
+ * the restriction from their associated mapped collections. This may be
5347
+ * set to null to disable this feature.
5400
5348
  *
5401
5349
  * If a restriction is in place for a collection, then HTTPS access to
5402
5350
  * it is disabled.
@@ -5421,8 +5369,8 @@ export interface components {
5421
5369
  * collections on this mapped collection.
5422
5370
  * */
5423
5371
  sharing_users_allow?: string[] | null;
5424
- /** @description List of connector-specific usernames denied access to
5425
- * create new guest collections on this mapped collection.
5372
+ /** @description List of connector-specific usernames denied access to create new guest
5373
+ * collections on this mapped collection.
5426
5374
  * */
5427
5375
  sharing_users_deny?: string[] | null;
5428
5376
  /** @description Flag indicating whether the guest collection is subject to automatic
@@ -5438,9 +5386,8 @@ export interface components {
5438
5386
  *
5439
5387
  */
5440
5388
  storage_gateway_id?: string;
5441
- /** @description Flag indicating whether the collection has been marked as
5442
- * verified by the administrator of the subscription associated
5443
- * with this endpoint.
5389
+ /** @description Flag indicating whether the collection has been marked as verified by
5390
+ * the administrator of the subscription associated with this endpoint.
5444
5391
  * */
5445
5392
  readonly subscription_admin_verified?: boolean;
5446
5393
  /** @description TLSFTP URL for the data on this collection. */
@@ -5459,11 +5406,10 @@ export interface components {
5459
5406
  * message may be up to 256 characters long.
5460
5407
  * */
5461
5408
  user_message?: string | null;
5462
- /** @description Link to additional messaging for clients to display to users
5463
- * when interacting with this endpoint, linked to an
5464
- * HTTP or HTTPS URL. For guest collections, this property is
5465
- * read-only and is the same as the value of its related mapped
5466
- * collection.
5409
+ /** @description Link to additional messaging for clients to display to users when
5410
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
5411
+ * guest collections, this property is read-only and is the same as the
5412
+ * value of its related mapped collection.
5467
5413
  * */
5468
5414
  user_message_link?: string | null;
5469
5415
  };
@@ -5541,14 +5487,18 @@ export interface components {
5541
5487
  * @enum {string}
5542
5488
  */
5543
5489
  DATA_TYPE: "collection#1.15.0";
5544
- /** @description Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value. */
5490
+ /** @description Length of time that guest collection permissions are valid. Only
5491
+ * settable on HA guest collections and HA mapped collections and used
5492
+ * by guest collections attached to it. When set on both the mapped and
5493
+ * guest collections, the lesser value is in effect. Set to null to
5494
+ * delete any previously set value.
5495
+ * */
5545
5496
  acl_expiration_mins?: number | null;
5546
5497
  activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
5547
5498
  /** @description Flag indicating if this Collection allows users to create guest
5548
- * collections on it. This is always false if this is a guest
5549
- * collection. If this is changed to false on a mapped collection with
5550
- * associated guest collections, those collections will no longer be
5551
- * accessible.
5499
+ * collections on it. This is always false if this is a guest collection.
5500
+ * If this is changed to false on a mapped collection with associated
5501
+ * guest collections, those collections will no longer be accessible.
5552
5502
  * */
5553
5503
  allow_guest_collections?: boolean;
5554
5504
  /** @description Policy describing Globus flows to run when the collection is accessed.
@@ -5564,23 +5514,23 @@ export interface components {
5564
5514
  * for the mapped collection. Defaults to disabled.
5565
5515
  * */
5566
5516
  auto_delete_timeout?: number | null;
5567
- /** @description Path to be interpreted as the base path when creating a new
5568
- * collection. It is interpreted differently depending on the
5569
- * collection type being created. For a mapped collection, this is an
5570
- * absolute path on the storage system named by the
5571
- * storage_gateway_id. For a guest collection, this is a relative
5572
- * path relative to the value of the `root_path` attribute on the
5573
- * mapped collection with the same Id as the `mapped_collection_id`
5574
- * property. This may not be changed once the collection is created.
5517
+ /** @description Path to be interpreted as the base path when creating a new collection.
5518
+ * It is interpreted differently depending on the collection type being
5519
+ * created. For a mapped collection, this is an absolute path on the
5520
+ * storage system named by the storage_gateway_id. For a guest collection,
5521
+ * this is a relative path relative to the value of the `root_path`
5522
+ * attribute on the mapped collection with the same Id as the
5523
+ * `mapped_collection_id` property. This may not be changed once the
5524
+ * collection is created.
5575
5525
  *
5576
5526
  * Support for `~` was added in API version 1.21.0.
5577
5527
  * */
5578
5528
  collection_base_path: string;
5579
5529
  /**
5580
- * @description Type of collection. A `mapped` collection requires an account on
5581
- * the system to access the administrator-defined collection. A
5582
- * `guest` collection allows users to share access to their data on a
5583
- * Storage Gateway by registering a credential with the GCS Manager.
5530
+ * @description Type of collection. A `mapped` collection requires an account on the
5531
+ * system to access the administrator-defined collection. A `guest`
5532
+ * collection allows users to share access to their data on a Storage
5533
+ * Gateway by registering a credential with the GCS Manager.
5584
5534
  *
5585
5535
  * @enum {string}
5586
5536
  */
@@ -5590,12 +5540,13 @@ export interface components {
5590
5540
  * @description Id of the connector type that is used by this collection.
5591
5541
  */
5592
5542
  readonly connector_id?: string;
5593
- /** @description Email address of the support contact for this collection. This is visible
5594
- * to end users so that they may contact your organization for support.
5543
+ /** @description Email address of the support contact for this collection. This is
5544
+ * visible to end users so that they may contact your organization for
5545
+ * support.
5595
5546
  * */
5596
5547
  contact_email?: string | null;
5597
- /** @description Other non-email contact information for the collection, e.g. phone and
5598
- * mailing address. This is visible to end users for support.
5548
+ /** @description Other non-email contact information for the collection, e.g. phone
5549
+ * and mailing address. This is visible to end users for support.
5599
5550
  * */
5600
5551
  contact_info?: string | null;
5601
5552
  /**
@@ -5607,11 +5558,10 @@ export interface components {
5607
5558
  * the special string `$USER` which is evaluated at access time to be
5608
5559
  * the connector-specific username accessing the data.
5609
5560
  *
5610
- * If the collection is mapped collection with a
5611
- * **collection_base_path** value of `/`, this value can also begin
5612
- * with the values `/~/` and `$HOME`, which are replaced by the user's
5613
- * home directory, or `/` if the connector does not support the
5614
- * concept of a home directory.
5561
+ * If the collection is mapped collection with a **collection_base_path**
5562
+ * value of `/`, this value can also begin with the values `/~/` and
5563
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
5564
+ * the connector does not support the concept of a home directory.
5615
5565
  * */
5616
5566
  default_directory?: string;
5617
5567
  /** @description If set to true, this collection can not be deleted. This property
@@ -5621,15 +5571,14 @@ export interface components {
5621
5571
  delete_protected?: boolean;
5622
5572
  /** @description Flag indicating that this collection has been deleted */
5623
5573
  readonly deleted?: boolean;
5624
- /** @description Department within organization that runs the server(s).
5625
- * Searchable. Optional. Unicode string, max 1024
5626
- * characters, no new lines.
5574
+ /** @description Department within organization that runs the server(s). Searchable.
5575
+ * Optional. Unicode string, max 1024 characters, no new lines.
5627
5576
  * */
5628
5577
  department?: string | null;
5629
5578
  /** @description A description of the collection. */
5630
5579
  description?: string | null;
5631
- /** @description Flag indicating if guest collections on this mapped collection
5632
- * allow anonymous write permissions or not. This flag is always true for high
5580
+ /** @description Flag indicating if guest collections on this mapped collection allow
5581
+ * anonymous write permissions or not. This flag is always true for high
5633
5582
  * assurance collections. For non-high assurance mapped collections, the
5634
5583
  * default value is false.
5635
5584
  * */
@@ -5638,15 +5587,15 @@ export interface components {
5638
5587
  * checksums, needed for the verify_checksum option of transfer.
5639
5588
  * */
5640
5589
  disable_verify?: boolean;
5641
- /** @description Friendly name for the collection. Unicode string, max 128
5642
- * characters, no new lines (`\r` or `\n`).
5590
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
5591
+ * no new lines (`\r` or `\n`).
5643
5592
  * */
5644
5593
  display_name: string;
5645
5594
  domain?: components["schemas"]["Domain"];
5646
5595
  /** @description DNS name of the virtual host serving this collection. For mapped
5647
- * collections which do not have a custom domain, this may be specified as
5648
- * part of the input document to create the collection, otherwise this is
5649
- * a read-only property. When included in the input, the name is
5596
+ * collections which do not have a custom domain, this may be specified
5597
+ * as part of the input document to create the collection, otherwise this
5598
+ * is a read-only property. When included in the input, the name is
5650
5599
  * restricted to be a subdomain of the endpoint, and the input name label
5651
5600
  * may not start with `m-` or `g-`.
5652
5601
  * */
@@ -5662,8 +5611,7 @@ export interface components {
5662
5611
  *
5663
5612
  * __New in v5.4.17__: If a mapped collection forces encryption, all
5664
5613
  * of its guest collections must as well. If this option is used on a
5665
- * mapped collection, the value is propagated to its guest
5666
- * collections.
5614
+ * mapped collection, the value is propagated to its guest collections.
5667
5615
  * */
5668
5616
  force_encryption?: boolean;
5669
5617
  /** @description Flag indicating that this endpoint requires computing checksums,
@@ -5687,8 +5635,8 @@ export interface components {
5687
5635
  readonly https_url?: string;
5688
5636
  /**
5689
5637
  * Format: uuid
5690
- * @description Unique identifier for this collection. This is assigned
5691
- * by the GCS manager when creating a collection.
5638
+ * @description Unique identifier for this collection. This is assigned by the GCS
5639
+ * manager when creating a collection.
5692
5640
  *
5693
5641
  */
5694
5642
  readonly id?: string;
@@ -5701,9 +5649,8 @@ export interface components {
5701
5649
  identity_id?: string;
5702
5650
  /** @description Link to a web page with more information about the collection */
5703
5651
  info_link?: string | null;
5704
- /** @description List of search keywords for the
5705
- * endpoint. Optional. Unicode string, max 1024
5706
- * characters total across all strings.
5652
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
5653
+ * max 1024 characters total across all strings.
5707
5654
  * */
5708
5655
  keywords?: string[];
5709
5656
  /**
@@ -5743,11 +5690,11 @@ export interface components {
5743
5690
  * */
5744
5691
  readonly require_mfa?: boolean;
5745
5692
  /**
5746
- * @description Flag indicating whether all data transfers to and from this
5747
- * collection require the remote collection be HA. This can only be
5748
- * assigned on high assurance mapped collections. High assurance
5749
- * guest collections inherit the restriction from their associated
5750
- * mapped collections. This may be set to null to disable this feature.
5693
+ * @description Flag indicating whether all data transfers to and from this collection
5694
+ * require the remote collection be HA. This can only be assigned on high
5695
+ * assurance mapped collections. High assurance guest collections inherit
5696
+ * the restriction from their associated mapped collections. This may be
5697
+ * set to null to disable this feature.
5751
5698
  *
5752
5699
  * If a restriction is in place for a collection, then HTTPS access to
5753
5700
  * it is disabled.
@@ -5772,8 +5719,8 @@ export interface components {
5772
5719
  * collections on this mapped collection.
5773
5720
  * */
5774
5721
  sharing_users_allow?: string[] | null;
5775
- /** @description List of connector-specific usernames denied access to
5776
- * create new guest collections on this mapped collection.
5722
+ /** @description List of connector-specific usernames denied access to create new guest
5723
+ * collections on this mapped collection.
5777
5724
  * */
5778
5725
  sharing_users_deny?: string[] | null;
5779
5726
  /** @description Flag indicating whether the guest collection is subject to automatic
@@ -5789,9 +5736,8 @@ export interface components {
5789
5736
  *
5790
5737
  */
5791
5738
  storage_gateway_id?: string;
5792
- /** @description Flag indicating whether the collection has been marked as
5793
- * verified by the administrator of the subscription associated
5794
- * with this endpoint.
5739
+ /** @description Flag indicating whether the collection has been marked as verified by
5740
+ * the administrator of the subscription associated with this endpoint.
5795
5741
  * */
5796
5742
  readonly subscription_admin_verified?: boolean;
5797
5743
  /** @description TLSFTP URL for the data on this collection. */
@@ -5810,12 +5756,373 @@ export interface components {
5810
5756
  * message may be up to 256 characters long.
5811
5757
  * */
5812
5758
  user_message?: string | null;
5813
- /** @description Link to additional messaging for clients to display to users
5814
- * when interacting with this endpoint, linked to an
5815
- * HTTP or HTTPS URL. For guest collections, this property is
5816
- * read-only and is the same as the value of its related mapped
5759
+ /** @description Link to additional messaging for clients to display to users when
5760
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
5761
+ * guest collections, this property is read-only and is the same as the
5762
+ * value of its related mapped collection.
5763
+ * */
5764
+ user_message_link?: string | null;
5765
+ };
5766
+ /**
5767
+ * Collection_1_16_0
5768
+ * @description A collection consists of metadata about the collection, a DNS
5769
+ * domain for accessing data on the collection, and configuration on
5770
+ * the Data Transfer Nodes to access the collection data. Globus
5771
+ * Connect Server version 5 supports two types of collections:
5772
+ * **mapped** and **guest**.
5773
+ *
5774
+ * Version 1.1.0 adds support for enabling or disabling https access for
5775
+ * individual collections, as well as the ability for collection
5776
+ * administrators to add an optional message and web link to be shown on
5777
+ * the Globus Web App when users visit the collection.
5778
+ *
5779
+ * Version 1.2.0 adds the ability to enable or disable sharing by specific
5780
+ * users.
5781
+ *
5782
+ * Version 1.3.0 add support for custom DNS domains on collections.
5783
+ *
5784
+ * Version 1.4.0 allows optional multi-factor authentication requirements to
5785
+ * high assurance collections and the ability to require checksums when
5786
+ * transferring data on this collection.
5787
+ *
5788
+ * Version 1.5.0 allows administrators to disable permissions that would allow
5789
+ * anonymous users to have write access to an endpoint.
5790
+ *
5791
+ * Version 1.6.0 allows administrators of mapped collections to associate
5792
+ * policies that users accessing guest collections must meet beyond the
5793
+ * guest collection permissions.
5794
+ *
5795
+ * Version 1.7.0 increases the maximum allowed length of the user_message
5796
+ * property.
5797
+ *
5798
+ * Version 1.8.0 adds the delete_protected property. While it is set to true
5799
+ * on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
5800
+ * this is true by default.
5801
+ *
5802
+ * Version 1.9.0 adds the read-only last_access and created_at properties.
5803
+ *
5804
+ * Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
5805
+ *
5806
+ * Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
5807
+ *
5808
+ * Version 1.12.0 adds the restrict_transfers_to_high_assurance property to HA
5809
+ * collections.
5810
+ *
5811
+ * Version 1.13.0 adds the auto_delete_timeout property to mapped collections
5812
+ * and the skip_auto_delete property to guest collections.
5813
+ *
5814
+ * Version 1.14.0 adds the subscription_admin_verified property to collections
5815
+ * and activity_notification_policy to guest collections.
5816
+ *
5817
+ * Version 1.15.0 adds the associated_flow_policy property to the collection.
5818
+ *
5819
+ * Version 1.16.0 adds the preserve_modtime and https_methods property to the
5820
+ * collection.
5821
+ *
5822
+ */
5823
+ Collection_1_16_0: {
5824
+ /**
5825
+ * @description Type of this document
5826
+ * @default collection#1.16.0
5827
+ * @enum {string}
5828
+ */
5829
+ DATA_TYPE: "collection#1.16.0";
5830
+ /** @description Length of time that guest collection permissions are valid. Only
5831
+ * settable on HA guest collections and HA mapped collections and used
5832
+ * by guest collections attached to it. When set on both the mapped and
5833
+ * guest collections, the lesser value is in effect. Set to null to
5834
+ * delete any previously set value.
5835
+ * */
5836
+ acl_expiration_mins?: number | null;
5837
+ activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
5838
+ /** @description Flag indicating if this Collection allows users to create guest
5839
+ * collections on it. This is always false if this is a guest collection.
5840
+ * If this is changed to false on a mapped collection with associated
5841
+ * guest collections, those collections will no longer be accessible.
5842
+ * */
5843
+ allow_guest_collections?: boolean;
5844
+ /** @description Policy describing Globus flows to run when the collection is accessed.
5845
+ * */
5846
+ associated_flow_policy?: unknown | components["schemas"]["FlowAssociation"];
5847
+ /** @description Timeout (in minutes) during which a user is required to have
5848
+ * authenticated in a session to access this storage gateway.
5849
+ * */
5850
+ readonly authentication_timeout_mins?: number;
5851
+ /** @description Number of days before unused guest collections will be automatically
5852
+ * deleted. Only settable on mapped collections. Values must be an integer
5853
+ * greater than 0. Set to null to disable automatic guest collection deletion
5854
+ * for the mapped collection. Defaults to disabled.
5855
+ * */
5856
+ auto_delete_timeout?: number | null;
5857
+ /** @description Path to be interpreted as the base path when creating a new collection.
5858
+ * It is interpreted differently depending on the collection type being
5859
+ * created. For a mapped collection, this is an absolute path on the
5860
+ * storage system named by the storage_gateway_id. For a guest collection,
5861
+ * this is a relative path relative to the value of the `root_path`
5862
+ * attribute on the mapped collection with the same Id as the
5863
+ * `mapped_collection_id` property. This may not be changed once the
5864
+ * collection is created.
5865
+ *
5866
+ * Support for `~` was added in API version 1.21.0.
5867
+ * */
5868
+ collection_base_path: string;
5869
+ /**
5870
+ * @description Type of collection. A `mapped` collection requires an account on the
5871
+ * system to access the administrator-defined collection. A `guest`
5872
+ * collection allows users to share access to their data on a Storage
5873
+ * Gateway by registering a credential with the GCS Manager.
5874
+ *
5875
+ * @enum {string}
5876
+ */
5877
+ collection_type: "mapped" | "guest";
5878
+ /**
5879
+ * Format: uuid
5880
+ * @description Id of the connector type that is used by this collection.
5881
+ */
5882
+ readonly connector_id?: string;
5883
+ /** @description Email address of the support contact for this collection. This is
5884
+ * visible to end users so that they may contact your organization for
5885
+ * support.
5886
+ * */
5887
+ contact_email?: string | null;
5888
+ /** @description Other non-email contact information for the collection, e.g. phone
5889
+ * and mailing address. This is visible to end users for support.
5890
+ * */
5891
+ contact_info?: string | null;
5892
+ /**
5893
+ * Format: date
5894
+ * @description Date on which this collection was created
5895
+ */
5896
+ readonly created_at?: string | null;
5897
+ /** @description Default directory when accessing the collection. This may include
5898
+ * the special string `$USER` which is evaluated at access time to be
5899
+ * the connector-specific username accessing the data.
5900
+ *
5901
+ * If the collection is mapped collection with a **collection_base_path**
5902
+ * value of `/`, this value can also begin with the values `/~/` and
5903
+ * `$HOME`, which are replaced by the user's home directory, or `/` if
5904
+ * the connector does not support the concept of a home directory.
5905
+ * */
5906
+ default_directory?: string;
5907
+ /** @description If set to true, this collection can not be deleted. This property
5908
+ * is available only on mapped collections. As of GCS 5.4.69, this is
5909
+ * true by default.
5910
+ * */
5911
+ delete_protected?: boolean;
5912
+ /** @description Flag indicating that this collection has been deleted */
5913
+ readonly deleted?: boolean;
5914
+ /** @description Department within organization that runs the server(s). Searchable.
5915
+ * Optional. Unicode string, max 1024 characters, no new lines.
5916
+ * */
5917
+ department?: string | null;
5918
+ /** @description A description of the collection. */
5919
+ description?: string | null;
5920
+ /** @description Flag indicating if guest collections on this mapped collection allow
5921
+ * anonymous write permissions or not. This flag is always true for high
5922
+ * assurance collections. For non-high assurance mapped collections, the
5923
+ * default value is false.
5924
+ * */
5925
+ disable_anonymous_writes?: boolean;
5926
+ /** @description Flag indicating that this endpoint does not support computing
5927
+ * checksums, needed for the verify_checksum option of transfer.
5928
+ * */
5929
+ disable_verify?: boolean;
5930
+ /** @description Friendly name for the collection. Unicode string, max 128 characters,
5931
+ * no new lines (`\r` or `\n`).
5932
+ * */
5933
+ display_name: string;
5934
+ domain?: components["schemas"]["Domain"];
5935
+ /** @description DNS name of the virtual host serving this collection. For mapped
5936
+ * collections which do not have a custom domain, this may be specified
5937
+ * as part of the input document to create the collection, otherwise this
5938
+ * is a read-only property. When included in the input, the name is
5939
+ * restricted to be a subdomain of the endpoint, and the input name label
5940
+ * may not start with `m-` or `g-`.
5941
+ * */
5942
+ domain_name?: string;
5943
+ /** @description Boolean flag indicating whether this collection should support
5944
+ * HTTPS. This value can be set on mapped collections or guest
5945
+ * collections. However, it may not be set to true on a guest
5946
+ * collection if the value on the related mapped collection is false.
5947
+ * */
5948
+ enable_https?: boolean;
5949
+ /** @description Flag indicating whether all data transfers to and from this
5950
+ * collection are always encrypted.
5951
+ *
5952
+ * __New in v5.4.17__: If a mapped collection forces encryption, all
5953
+ * of its guest collections must as well. If this option is used on a
5954
+ * mapped collection, the value is propagated to its guest collections.
5955
+ * */
5956
+ force_encryption?: boolean;
5957
+ /** @description Flag indicating that this endpoint requires computing checksums,
5958
+ * needed for the verify_checksum option of transfer.
5959
+ * */
5960
+ force_verify?: boolean;
5961
+ /**
5962
+ * Format: uuid
5963
+ * @description Authentication policy set on mapped collections and inherited by its
5964
+ * guest collections. During authorization, the authentication policy must
5965
+ * be satisfied before permissions are considered. Read-only on guest
5966
+ * collections. (**Added in API 1.15.0**)
5967
+ *
5968
+ */
5969
+ guest_auth_policy_id?: string | null;
5970
+ /** @description Flag indicating if this collection is created on a high assurance
5971
+ * Storage Gateway.
5972
+ * */
5973
+ readonly high_assurance?: boolean;
5974
+ /** @description List containing the supported HTTPS methods for this collection. Elements
5975
+ * in the list can be "GET", "PUT", or "DELETE".
5976
+ *
5977
+ * For a mapped collection, the default is ["GET", "PUT", "DELETE"].
5978
+ * For a guest collection, the default value is the value of the mapped
5979
+ * collection.
5980
+ *
5981
+ * A collection administrator may modify the list of supported methods by
5982
+ * modifying this property's value. A guest collection inherits the list of
5983
+ * supported methods from the mapped collection it is sharing data from, but
5984
+ * may disable methods by putting a value that excludes values supported by
5985
+ * the mapped collection.
5986
+ * */
5987
+ https_methods?: ("GET" | "PUT" | "DELETE")[];
5988
+ /** @description HTTPS URL for the data on this collection. */
5989
+ readonly https_url?: string;
5990
+ /**
5991
+ * Format: uuid
5992
+ * @description Unique identifier for this collection. This is assigned by the GCS
5993
+ * manager when creating a collection.
5994
+ *
5995
+ */
5996
+ readonly id?: string;
5997
+ /**
5998
+ * Format: uuid
5999
+ * @description Globus Auth identity to who acts as the owner of this collection.
6000
+ * This identity is an `administrator` on the collection.
6001
+ *
6002
+ */
6003
+ identity_id?: string;
6004
+ /** @description Link to a web page with more information about the collection */
6005
+ info_link?: string | null;
6006
+ /** @description List of search keywords for the endpoint. Optional. Unicode string,
6007
+ * max 1024 characters total across all strings.
6008
+ * */
6009
+ keywords?: string[];
6010
+ /**
6011
+ * Format: date
6012
+ * @description Date on which this collection was last accessed
6013
+ */
6014
+ readonly last_access?: string | null;
6015
+ /** @description URL of the GCS Manager API service for the endpoint hosting this
5817
6016
  * collection.
5818
6017
  * */
6018
+ readonly manager_url?: string;
6019
+ /**
6020
+ * Format: uuid
6021
+ * @description Unique ID of the Mapped Collection which this guest collection is
6022
+ * associated with. This is set on creation and may not be changed.
6023
+ * For a Guest Collection, this must be set, and policies related
6024
+ * sharing (`allow_guest_collections`, `sharing_restrict_paths`) will
6025
+ * always reflect the values in the Mapped Collection definition and
6026
+ * may not be changed on this Guest Collection.
6027
+ *
6028
+ */
6029
+ mapped_collection_id?: string;
6030
+ /** @description Organization that runs the server(s) represented by the endpoint.
6031
+ * Optional to preserve backward compatibility, but will eventually be
6032
+ * required and all clients are encouraged to require users to specify
6033
+ * it. Unicode string, max 1024 characters, no new lines.
6034
+ * */
6035
+ organization?: string;
6036
+ /** @description Connector-specific collection policies */
6037
+ policies?: components["schemas"]["S3CollectionPolicies_1_0_0"] | components["schemas"]["AzureBlobCollectionPolicies_1_0_0"] | components["schemas"]["BlackPearlCollectionPolicies_1_0_0"] | components["schemas"]["BoxCollectionPolicies_1_0_0"] | components["schemas"]["CephCollectionPolicies_1_0_0"] | components["schemas"]["DropboxCollectionPolicies_1_0_0"] | components["schemas"]["GoogleCloudStorageCollectionPolicies_1_0_0"] | components["schemas"]["GoogleDriveCollectionPolicies_1_0_0"] | components["schemas"]["HPSSCollectionPolicies_1_0_0"] | components["schemas"]["IrodsCollectionPolicies_1_0_0"] | components["schemas"]["OneDriveCollectionPolicies_1_0_0"] | components["schemas"]["PosixCollectionPolicies_1_0_0"] | components["schemas"]["PosixCollectionPolicies_1_1_0"] | components["schemas"]["PosixStagingCollectionPolicies_1_0_0"];
6038
+ /**
6039
+ * @description Flag indicating whether all data transfers to and from this
6040
+ * collection require the transfer to have the preserve_modtime
6041
+ * property set to true.
6042
+ *
6043
+ * @enum {string|null}
6044
+ */
6045
+ preserve_modtime?: "inbound" | "outbound" | "all" | null;
6046
+ /** @description Flag indicating whether this collection is visible to other Globus
6047
+ * users.
6048
+ * */
6049
+ public: boolean;
6050
+ /** @description Flag indicating if the storage_gateway requires multi-factor
6051
+ * authentication. Only applies to high assurance storage gateways.
6052
+ * */
6053
+ readonly require_mfa?: boolean;
6054
+ /**
6055
+ * @description Flag indicating whether all data transfers to and from this collection
6056
+ * require the remote collection be HA. This can only be assigned on high
6057
+ * assurance mapped collections. High assurance guest collections inherit
6058
+ * the restriction from their associated mapped collections. This may be
6059
+ * set to null to disable this feature.
6060
+ *
6061
+ * If a restriction is in place for a collection, then HTTPS access to
6062
+ * it is disabled.
6063
+ *
6064
+ * @enum {string|null}
6065
+ */
6066
+ restrict_transfers_to_high_assurance?: "inbound" | "outbound" | "all" | null;
6067
+ /** @description Absolute root path of the collection. All data access
6068
+ * is done relative to this path. On a guest collection,
6069
+ * this value is only visible if the caller has an
6070
+ * administrator role on both the guest collection and the
6071
+ * mapped collection it is created on.
6072
+ * */
6073
+ readonly root_path?: string;
6074
+ /** @description Restrictions on which paths may be shared in guest collections related
6075
+ * to this mapped collection. On the mapped collection, these paths are
6076
+ * relative to the root_path property of the mapped collection. On a guest
6077
+ * collection, they are absolute paths from the storage root.
6078
+ * */
6079
+ sharing_restrict_paths?: unknown | components["schemas"]["PathRestrictions"];
6080
+ /** @description List of connector-specific usernames allowed to create new guest
6081
+ * collections on this mapped collection.
6082
+ * */
6083
+ sharing_users_allow?: string[] | null;
6084
+ /** @description List of connector-specific usernames denied access to create new guest
6085
+ * collections on this mapped collection.
6086
+ * */
6087
+ sharing_users_deny?: string[] | null;
6088
+ /** @description Flag indicating whether the guest collection is subject to automatic
6089
+ * deletion if auto_delete_timeout is set on its mapped collection. Only
6090
+ * settable on guest collections. Defaults to false.
6091
+ * */
6092
+ skip_auto_delete?: boolean;
6093
+ /**
6094
+ * Format: uuid
6095
+ * @description Unique ID of the Storage Gateway which this collection provides
6096
+ * access to. This value can not change after the collection is
6097
+ * created.
6098
+ *
6099
+ */
6100
+ storage_gateway_id?: string;
6101
+ /** @description Flag indicating whether the collection has been marked as verified by
6102
+ * the administrator of the subscription associated with this endpoint.
6103
+ * */
6104
+ readonly subscription_admin_verified?: boolean;
6105
+ /** @description TLSFTP URL for the data on this collection. */
6106
+ readonly tlsftp_url?: string;
6107
+ /**
6108
+ * Format: uuid
6109
+ * @description The ID of the User Credential which is used to access data on this
6110
+ * collection. This credential must be owned by the collection's
6111
+ * identity_id.
6112
+ *
6113
+ */
6114
+ user_credential_id?: string;
6115
+ /** @description A message for clients to display to users when interacting with
6116
+ * this collection. For guest collections, this property is read-only
6117
+ * and is the same as the value of its related mapped collection. The
6118
+ * message may be up to 256 characters long.
6119
+ * */
6120
+ user_message?: string | null;
6121
+ /** @description Link to additional messaging for clients to display to users when
6122
+ * interacting with this endpoint, linked to an HTTP or HTTPS URL. For
6123
+ * guest collections, this property is read-only and is the same as the
6124
+ * value of its related mapped collection.
6125
+ * */
5819
6126
  user_message_link?: string | null;
5820
6127
  };
5821
6128
  /**
@@ -5947,13 +6254,17 @@ export interface components {
5947
6254
  DATA_TYPE: "endpoint#1.0.0";
5948
6255
  /** @description Allow data transfer on this endpoint using the UDT protocol */
5949
6256
  allow_udt?: boolean;
5950
- /** @description Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support. */
6257
+ /** @description Email address of the support contact for this endpoint. This is visible
6258
+ * to end users so that they may contact your organization for support.
6259
+ * */
5951
6260
  contact_email?: string;
5952
- /** @description Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support. */
5953
- contact_info?: string;
5954
- /** @description Department within organization that runs the server(s).
5955
- * Searchable. Unicode string, max 1024 characters, no new lines.
6261
+ /** @description Other non-email contact information for the endpoint, e.g. phone and
6262
+ * mailing address. This is visible to end users for support.
5956
6263
  * */
6264
+ contact_info?: string;
6265
+ /** @description Department within organization that runs the server(s). Searchable.
6266
+ * Unicode string, max 1024 characters, no new lines.
6267
+ * */
5957
6268
  department?: string;
5958
6269
  /** @description A description of the endpoint */
5959
6270
  description?: string;
@@ -5973,9 +6284,9 @@ export interface components {
5973
6284
  * verifying that it is accepting public connections.
5974
6285
  * */
5975
6286
  info_link?: string;
5976
- /** @description List of search keywords for the endpoint. Unicode
5977
- * string, max 1024 characters total across all strings.
5978
- * */
6287
+ /** @description List of search keywords for the endpoint. Unicode string, max 1024
6288
+ * characters total across all strings.
6289
+ * */
5979
6290
  keywords?: string[];
5980
6291
  /** @description Admin-specified value when the **network_use** property's value is
5981
6292
  * `custom`; otherwise the preset value for the specified
@@ -5983,8 +6294,7 @@ export interface components {
5983
6294
  * */
5984
6295
  max_concurrency?: number;
5985
6296
  /** @description Admin-specified value when the **network_use** property's value is
5986
- * `custom`; otherwise the preset value for the specified
5987
- * **network_use**.
6297
+ * `custom`; otherwise the preset value for the specified **network_use**.
5988
6298
  * */
5989
6299
  max_parallelism?: number;
5990
6300
  /**
@@ -5994,8 +6304,8 @@ export interface components {
5994
6304
  *
5995
6305
  * * `normal`
5996
6306
  * - The default setting. Uses an average level of concurrency and
5997
- * parallelism. The levels depend on the number of physical
5998
- * servers in the endpoint.
6307
+ * parallelism. The levels depend on the number of physical servers
6308
+ * in the endpoint.
5999
6309
  * * `minimal`
6000
6310
  * - Uses a minimal level of concurrency and parallelism.
6001
6311
  * * `aggressive`
@@ -6015,27 +6325,25 @@ export interface components {
6015
6325
  * */
6016
6326
  organization?: string;
6017
6327
  /** @description Admin-specified value when the **network_use** property's value is
6018
- * `custom`; otherwise the preset value for the specified
6019
- * **network_use**.
6328
+ * `custom`; otherwise the preset value for the specified **network_use**.
6020
6329
  * */
6021
6330
  preferred_concurrency?: number;
6022
6331
  /** @description Admin-specified value when the **network_use** property's value is
6023
- * `custom`; otherwise the preset value for the specified
6024
- * **network_use**.
6332
+ * `custom`; otherwise the preset value for the specified **network_use**.
6025
6333
  * */
6026
6334
  preferred_parallelism?: number;
6027
6335
  /**
6028
- * @description Flag indicating whether this endpoint is visible to all other
6029
- * Globus users. If false, only users which have been granted a role
6030
- * on the endpoint or one of its collections, or belong to a domain
6031
- * allowed access to any of its storage gateways may view it.
6336
+ * @description Flag indicating whether this endpoint is visible to all other Globus
6337
+ * users. If false, only users which have been granted a role on the
6338
+ * endpoint or one of its collections, or belong to a domain allowed
6339
+ * access to any of its storage gateways may view it.
6032
6340
  *
6033
6341
  * @default true
6034
6342
  */
6035
6343
  public: boolean;
6036
- /** @description The id of the subscription that is managing this endpoint. This may be
6037
- * the special value `DEFAULT` when using this as input to PATCH or PUT to
6038
- * use the caller's default subscription id.
6344
+ /** @description The id of the subscription that is managing this endpoint. This may
6345
+ * be the special value `DEFAULT` when using this as input to PATCH or PUT
6346
+ * to use the caller's default subscription id.
6039
6347
  * */
6040
6348
  subscription_id?: string | null;
6041
6349
  };
@@ -6061,13 +6369,17 @@ export interface components {
6061
6369
  DATA_TYPE: "endpoint#1.1.0";
6062
6370
  /** @description Allow data transfer on this endpoint using the UDT protocol */
6063
6371
  allow_udt?: boolean;
6064
- /** @description Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support. */
6372
+ /** @description Email address of the support contact for this endpoint. This is visible
6373
+ * to end users so that they may contact your organization for support.
6374
+ * */
6065
6375
  contact_email?: string;
6066
- /** @description Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support. */
6067
- contact_info?: string;
6068
- /** @description Department within organization that runs the server(s).
6069
- * Searchable. Unicode string, max 1024 characters, no new lines.
6376
+ /** @description Other non-email contact information for the endpoint, e.g. phone and
6377
+ * mailing address. This is visible to end users for support.
6070
6378
  * */
6379
+ contact_info?: string;
6380
+ /** @description Department within organization that runs the server(s). Searchable.
6381
+ * Unicode string, max 1024 characters, no new lines.
6382
+ * */
6071
6383
  department?: string;
6072
6384
  /** @description A description of the endpoint */
6073
6385
  description?: string;
@@ -6082,9 +6394,9 @@ export interface components {
6082
6394
  id?: string;
6083
6395
  /** @description URL of the GCS Manager API service for this endpoint */
6084
6396
  readonly gcs_manager_url?: string;
6085
- /** @description TCP port for the Globus control channel to listen on. By default,
6086
- * the control channel is passed through 443 with an ALPN header
6087
- * containing the value "ftp".
6397
+ /** @description TCP port for the Globus control channel to listen on. By default, the
6398
+ * control channel is passed through 443 with an ALPN header containing
6399
+ * the value "ftp".
6088
6400
  * */
6089
6401
  gridftp_control_channel_port?: number | null;
6090
6402
  /** @description Link to a web page with more information about the endpoint. The
@@ -6092,9 +6404,9 @@ export interface components {
6092
6404
  * verifying that it is accepting public connections.
6093
6405
  * */
6094
6406
  info_link?: string;
6095
- /** @description List of search keywords for the endpoint. Unicode
6096
- * string, max 1024 characters total across all strings.
6097
- * */
6407
+ /** @description List of search keywords for the endpoint. Unicode string, max 1024
6408
+ * characters total across all strings.
6409
+ * */
6098
6410
  keywords?: string[];
6099
6411
  /** @description Admin-specified value when the **network_use** property's value is
6100
6412
  * `custom`; otherwise the preset value for the specified
@@ -6102,8 +6414,7 @@ export interface components {
6102
6414
  * */
6103
6415
  max_concurrency?: number;
6104
6416
  /** @description Admin-specified value when the **network_use** property's value is
6105
- * `custom`; otherwise the preset value for the specified
6106
- * **network_use**.
6417
+ * `custom`; otherwise the preset value for the specified **network_use**.
6107
6418
  * */
6108
6419
  max_parallelism?: number;
6109
6420
  /**
@@ -6113,8 +6424,8 @@ export interface components {
6113
6424
  *
6114
6425
  * * `normal`
6115
6426
  * - The default setting. Uses an average level of concurrency and
6116
- * parallelism. The levels depend on the number of physical
6117
- * servers in the endpoint.
6427
+ * parallelism. The levels depend on the number of physical servers
6428
+ * in the endpoint.
6118
6429
  * * `minimal`
6119
6430
  * - Uses a minimal level of concurrency and parallelism.
6120
6431
  * * `aggressive`
@@ -6134,27 +6445,25 @@ export interface components {
6134
6445
  * */
6135
6446
  organization?: string;
6136
6447
  /** @description Admin-specified value when the **network_use** property's value is
6137
- * `custom`; otherwise the preset value for the specified
6138
- * **network_use**.
6448
+ * `custom`; otherwise the preset value for the specified **network_use**.
6139
6449
  * */
6140
6450
  preferred_concurrency?: number;
6141
6451
  /** @description Admin-specified value when the **network_use** property's value is
6142
- * `custom`; otherwise the preset value for the specified
6143
- * **network_use**.
6452
+ * `custom`; otherwise the preset value for the specified **network_use**.
6144
6453
  * */
6145
6454
  preferred_parallelism?: number;
6146
6455
  /**
6147
- * @description Flag indicating whether this endpoint is visible to all other
6148
- * Globus users. If false, only users which have been granted a role
6149
- * on the endpoint or one of its collections, or belong to a domain
6150
- * allowed access to any of its storage gateways may view it.
6456
+ * @description Flag indicating whether this endpoint is visible to all other Globus
6457
+ * users. If false, only users which have been granted a role on the
6458
+ * endpoint or one of its collections, or belong to a domain allowed
6459
+ * access to any of its storage gateways may view it.
6151
6460
  *
6152
6461
  * @default true
6153
6462
  */
6154
6463
  public: boolean;
6155
- /** @description The id of the subscription that is managing this endpoint. This may be
6156
- * the special value `DEFAULT` when using this as input to PATCH or PUT to
6157
- * use the caller's default subscription id.
6464
+ /** @description The id of the subscription that is managing this endpoint. This may
6465
+ * be the special value `DEFAULT` when using this as input to PATCH or PUT
6466
+ * to use the caller's default subscription id.
6158
6467
  * */
6159
6468
  subscription_id?: string | null;
6160
6469
  };
@@ -6183,13 +6492,17 @@ export interface components {
6183
6492
  DATA_TYPE: "endpoint#1.2.0";
6184
6493
  /** @description Allow data transfer on this endpoint using the UDT protocol */
6185
6494
  allow_udt?: boolean;
6186
- /** @description Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support. */
6495
+ /** @description Email address of the support contact for this endpoint. This is visible
6496
+ * to end users so that they may contact your organization for support.
6497
+ * */
6187
6498
  contact_email?: string;
6188
- /** @description Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support. */
6189
- contact_info?: string;
6190
- /** @description Department within organization that runs the server(s).
6191
- * Searchable. Unicode string, max 1024 characters, no new lines.
6499
+ /** @description Other non-email contact information for the endpoint, e.g. phone and
6500
+ * mailing address. This is visible to end users for support.
6192
6501
  * */
6502
+ contact_info?: string;
6503
+ /** @description Department within organization that runs the server(s). Searchable.
6504
+ * Unicode string, max 1024 characters, no new lines.
6505
+ * */
6193
6506
  department?: string;
6194
6507
  /** @description A description of the endpoint */
6195
6508
  description?: string;
@@ -6211,9 +6524,9 @@ export interface components {
6211
6524
  id?: string;
6212
6525
  /** @description URL of the GCS Manager API service for this endpoint */
6213
6526
  readonly gcs_manager_url?: string;
6214
- /** @description TCP port for the Globus control channel to listen on. By default,
6215
- * the control channel is passed through 443 with an ALPN header
6216
- * containing the value "ftp".
6527
+ /** @description TCP port for the Globus control channel to listen on. By default, the
6528
+ * control channel is passed through 443 with an ALPN header containing
6529
+ * the value "ftp".
6217
6530
  * */
6218
6531
  gridftp_control_channel_port?: number | null;
6219
6532
  /** @description Link to a web page with more information about the endpoint. The
@@ -6221,9 +6534,9 @@ export interface components {
6221
6534
  * verifying that it is accepting public connections.
6222
6535
  * */
6223
6536
  info_link?: string;
6224
- /** @description List of search keywords for the endpoint. Unicode
6225
- * string, max 1024 characters total across all strings.
6226
- * */
6537
+ /** @description List of search keywords for the endpoint. Unicode string, max 1024
6538
+ * characters total across all strings.
6539
+ * */
6227
6540
  keywords?: string[];
6228
6541
  /** @description Admin-specified value when the **network_use** property's value is
6229
6542
  * `custom`; otherwise the preset value for the specified
@@ -6231,8 +6544,7 @@ export interface components {
6231
6544
  * */
6232
6545
  max_concurrency?: number;
6233
6546
  /** @description Admin-specified value when the **network_use** property's value is
6234
- * `custom`; otherwise the preset value for the specified
6235
- * **network_use**.
6547
+ * `custom`; otherwise the preset value for the specified **network_use**.
6236
6548
  * */
6237
6549
  max_parallelism?: number;
6238
6550
  /**
@@ -6242,8 +6554,8 @@ export interface components {
6242
6554
  *
6243
6555
  * * `normal`
6244
6556
  * - The default setting. Uses an average level of concurrency and
6245
- * parallelism. The levels depend on the number of physical
6246
- * servers in the endpoint.
6557
+ * parallelism. The levels depend on the number of physical servers
6558
+ * in the endpoint.
6247
6559
  * * `minimal`
6248
6560
  * - Uses a minimal level of concurrency and parallelism.
6249
6561
  * * `aggressive`
@@ -6263,27 +6575,25 @@ export interface components {
6263
6575
  * */
6264
6576
  organization?: string;
6265
6577
  /** @description Admin-specified value when the **network_use** property's value is
6266
- * `custom`; otherwise the preset value for the specified
6267
- * **network_use**.
6578
+ * `custom`; otherwise the preset value for the specified **network_use**.
6268
6579
  * */
6269
6580
  preferred_concurrency?: number;
6270
6581
  /** @description Admin-specified value when the **network_use** property's value is
6271
- * `custom`; otherwise the preset value for the specified
6272
- * **network_use**.
6582
+ * `custom`; otherwise the preset value for the specified **network_use**.
6273
6583
  * */
6274
6584
  preferred_parallelism?: number;
6275
6585
  /**
6276
- * @description Flag indicating whether this endpoint is visible to all other
6277
- * Globus users. If false, only users which have been granted a role
6278
- * on the endpoint or one of its collections, or belong to a domain
6279
- * allowed access to any of its storage gateways may view it.
6586
+ * @description Flag indicating whether this endpoint is visible to all other Globus
6587
+ * users. If false, only users which have been granted a role on the
6588
+ * endpoint or one of its collections, or belong to a domain allowed
6589
+ * access to any of its storage gateways may view it.
6280
6590
  *
6281
6591
  * @default true
6282
6592
  */
6283
6593
  public: boolean;
6284
- /** @description The id of the subscription that is managing this endpoint. This may be
6285
- * the special value `DEFAULT` when using this as input to PATCH or PUT to
6286
- * use the caller's default subscription id.
6594
+ /** @description The id of the subscription that is managing this endpoint. This may
6595
+ * be the special value `DEFAULT` when using this as input to PATCH or PUT
6596
+ * to use the caller's default subscription id.
6287
6597
  * */
6288
6598
  subscription_id?: string | null;
6289
6599
  };
@@ -6317,9 +6627,9 @@ export interface components {
6317
6627
  * @enum {string}
6318
6628
  */
6319
6629
  DATA_TYPE: "endpoint_subscription#1.0.0";
6320
- /** @description Either the id of a Globus subscription or the special value
6321
- * "DEFAULT" if the caller has only one subscription associated with
6322
- * their identity set.
6630
+ /** @description Either the id of a Globus subscription or the special value "DEFAULT"
6631
+ * if the caller has only one subscription associated with their identity
6632
+ * set.
6323
6633
  * */
6324
6634
  subscription_id: string | null;
6325
6635
  };
@@ -6419,8 +6729,8 @@ export interface components {
6419
6729
  * @enum {string}
6420
6730
  */
6421
6731
  DATA_TYPE: "invalid_input#1.0.0";
6422
- /** @description Optional list of input schema violations, such as missing or
6423
- * unknown properties, or properties with invalid values.
6732
+ /** @description Optional list of input schema violations, such as missing or unknown
6733
+ * properties, or properties with invalid values.
6424
6734
  * */
6425
6735
  errors?: components["schemas"]["InvalidInputItem"][];
6426
6736
  };
@@ -6492,13 +6802,13 @@ export interface components {
6492
6802
  * */
6493
6803
  ignore_case?: boolean;
6494
6804
  /** @description Flag indicating the match expression should be done as a literal
6495
- * match, ignoring any special regular characters. If not present,
6496
- * this defaults to false.
6805
+ * match, ignoring any special regular characters. If not present, this
6806
+ * defaults to false.
6497
6807
  * */
6498
6808
  literal?: boolean;
6499
- /** @description An expression which is applied to the output performing
6500
- * interpolation on source for determining if this mapping applies.
6501
- * This requires a full string match on the source.
6809
+ /** @description An expression which is applied to the output performing interpolation
6810
+ * on source for determining if this mapping applies. This requires a
6811
+ * full string match on the source.
6502
6812
  * */
6503
6813
  match?: string;
6504
6814
  /** @description A string representing the result of the mapping if the match
@@ -6611,8 +6921,8 @@ export interface components {
6611
6921
  DATA_TYPE: "node#1.0.0";
6612
6922
  /**
6613
6923
  * Format: uuid
6614
- * @description Unique id string this node. This is system generated and may not
6615
- * be included in create requests.
6924
+ * @description Unique id string this node. This is system generated and may not be
6925
+ * included in create requests.
6616
6926
  *
6617
6927
  */
6618
6928
  id?: string;
@@ -6624,9 +6934,9 @@ export interface components {
6624
6934
  outgoing_port_range?: number[];
6625
6935
  /**
6626
6936
  * @description Current status of the Node. If a Node is marked *inactive*, it will
6627
- * be removed from the DNS entries for this endpoint and will return
6628
- * an error on any attempt to use the Manager API or attempt a
6629
- * Transfer using this node.
6937
+ * be removed from the DNS entries for this endpoint and will return an
6938
+ * error on any attempt to use the Manager API or attempt a Transfer
6939
+ * using this node.
6630
6940
  *
6631
6941
  * @enum {string}
6632
6942
  */
@@ -6654,8 +6964,8 @@ export interface components {
6654
6964
  data_interface?: string | null;
6655
6965
  /**
6656
6966
  * Format: uuid
6657
- * @description Unique id string this node. This is system generated and may not
6658
- * be included in create requests.
6967
+ * @description Unique id string this node. This is system generated and may not be
6968
+ * included in create requests.
6659
6969
  *
6660
6970
  */
6661
6971
  id?: string;
@@ -6667,9 +6977,9 @@ export interface components {
6667
6977
  outgoing_port_range?: number[];
6668
6978
  /**
6669
6979
  * @description Current status of the Node. If a Node is marked *inactive*, it will
6670
- * be removed from the DNS entries for this endpoint and will return
6671
- * an error on any attempt to use the Manager API or attempt a
6672
- * Transfer using this node.
6980
+ * be removed from the DNS entries for this endpoint and will return an
6981
+ * error on any attempt to use the Manager API or attempt a Transfer
6982
+ * using this node.
6673
6983
  *
6674
6984
  * @enum {string}
6675
6985
  */
@@ -6701,8 +7011,8 @@ export interface components {
6701
7011
  data_interface6?: string | null;
6702
7012
  /**
6703
7013
  * Format: uuid
6704
- * @description Unique id string this node. This is system generated and may not
6705
- * be included in create requests.
7014
+ * @description Unique id string this node. This is system generated and may not be
7015
+ * included in create requests.
6706
7016
  *
6707
7017
  */
6708
7018
  id?: string;
@@ -6714,9 +7024,9 @@ export interface components {
6714
7024
  outgoing_port_range?: number[];
6715
7025
  /**
6716
7026
  * @description Current status of the Node. If a Node is marked *inactive*, it will
6717
- * be removed from the DNS entries for this endpoint and will return
6718
- * an error on any attempt to use the Manager API or attempt a
6719
- * Transfer using this node.
7027
+ * be removed from the DNS entries for this endpoint and will return an
7028
+ * error on any attempt to use the Manager API or attempt a Transfer
7029
+ * using this node.
6720
7030
  *
6721
7031
  * @enum {string}
6722
7032
  */
@@ -6769,8 +7079,8 @@ export interface components {
6769
7079
  * @enum {string}
6770
7080
  */
6771
7081
  DATA_TYPE: "subscription_admin_verified#1.0.0";
6772
- /** @description Value of the subscription_admin_verified property of a collection. This
6773
- * can be set or cleared by a subscription group administrator.
7082
+ /** @description Value of the subscription_admin_verified property of a collection.
7083
+ * This can be set or cleared by a subscription group administrator.
6774
7084
  * */
6775
7085
  subscription_admin_verified: boolean;
6776
7086
  };
@@ -6990,8 +7300,7 @@ export interface components {
6990
7300
  deleted?: boolean;
6991
7301
  /** @description Name of the storage gateway */
6992
7302
  display_name?: string;
6993
- /** @description Flag indicating if the storage_gateway requires high
6994
- * assurance features.
7303
+ /** @description Flag indicating if the storage_gateway requires high assurance features.
6995
7304
  * */
6996
7305
  high_assurance?: boolean | null;
6997
7306
  /**
@@ -7003,8 +7312,8 @@ export interface components {
7003
7312
  * what connector-specific accounts are available for access.
7004
7313
  * */
7005
7314
  identity_mappings?: components["schemas"]["IdentityMapping"][] | null;
7006
- /** @description Name of the DSI module to load by the GridFTP server when
7007
- * accessing this storage gateway.
7315
+ /** @description Name of the DSI module to load by the GridFTP server when accessing
7316
+ * this storage gateway.
7008
7317
  * */
7009
7318
  load_dsi_module?: string | null;
7010
7319
  /** @description Connector-specific storage policies */
@@ -7086,8 +7395,7 @@ export interface components {
7086
7395
  deleted?: boolean;
7087
7396
  /** @description Name of the storage gateway */
7088
7397
  display_name?: string;
7089
- /** @description Flag indicating if the storage_gateway requires high
7090
- * assurance features.
7398
+ /** @description Flag indicating if the storage_gateway requires high assurance features.
7091
7399
  * */
7092
7400
  high_assurance?: boolean | null;
7093
7401
  /**
@@ -7099,8 +7407,8 @@ export interface components {
7099
7407
  * what connector-specific accounts are available for access.
7100
7408
  * */
7101
7409
  identity_mappings?: components["schemas"]["IdentityMapping"][] | null;
7102
- /** @description Name of the DSI module to load by the GridFTP server when
7103
- * accessing this storage gateway.
7410
+ /** @description Name of the DSI module to load by the GridFTP server when accessing
7411
+ * this storage gateway.
7104
7412
  * */
7105
7413
  load_dsi_module?: string | null;
7106
7414
  /** @description Connector-specific storage policies */
@@ -7164,8 +7472,8 @@ export interface components {
7164
7472
  */
7165
7473
  DATA_TYPE: "storage_gateway#1.2.0";
7166
7474
  /**
7167
- * @description Flag indicating if the storage_gateway allows endpoint
7168
- * administrators to manage user credentials on behalf of other users.
7475
+ * @description Flag indicating if the storage_gateway allows endpoint administrators
7476
+ * to manage user credentials on behalf of other users.
7169
7477
  *
7170
7478
  * @default false
7171
7479
  */
@@ -7198,8 +7506,7 @@ export interface components {
7198
7506
  deleted?: boolean;
7199
7507
  /** @description Name of the storage gateway */
7200
7508
  display_name?: string;
7201
- /** @description Flag indicating if the storage_gateway requires high
7202
- * assurance features.
7509
+ /** @description Flag indicating if the storage_gateway requires high assurance features.
7203
7510
  * */
7204
7511
  high_assurance?: boolean | null;
7205
7512
  /**
@@ -7211,8 +7518,8 @@ export interface components {
7211
7518
  * what connector-specific accounts are available for access.
7212
7519
  * */
7213
7520
  identity_mappings?: components["schemas"]["IdentityMapping"][] | null;
7214
- /** @description Name of the DSI module to load by the GridFTP server when
7215
- * accessing this storage gateway.
7521
+ /** @description Name of the DSI module to load by the GridFTP server when accessing
7522
+ * this storage gateway.
7216
7523
  * */
7217
7524
  load_dsi_module?: string | null;
7218
7525
  /** @description Connector-specific storage policies */
@@ -7279,8 +7586,8 @@ export interface components {
7279
7586
  */
7280
7587
  DATA_TYPE: "storage_gateway#1.3.0";
7281
7588
  /**
7282
- * @description Flag indicating if the storage_gateway allows endpoint
7283
- * administrators to manage user credentials on behalf of other users.
7589
+ * @description Flag indicating if the storage_gateway allows endpoint administrators
7590
+ * to manage user credentials on behalf of other users.
7284
7591
  *
7285
7592
  * @default false
7286
7593
  */
@@ -7313,8 +7620,7 @@ export interface components {
7313
7620
  deleted?: boolean;
7314
7621
  /** @description Name of the storage gateway */
7315
7622
  display_name?: string;
7316
- /** @description Flag indicating if the storage_gateway requires high
7317
- * assurance features.
7623
+ /** @description Flag indicating if the storage_gateway requires high assurance features.
7318
7624
  * */
7319
7625
  high_assurance?: boolean | null;
7320
7626
  /**
@@ -7326,8 +7632,8 @@ export interface components {
7326
7632
  * what connector-specific accounts are available for access.
7327
7633
  * */
7328
7634
  identity_mappings?: components["schemas"]["IdentityMapping"][] | null;
7329
- /** @description Name of the DSI module to load by the GridFTP server when
7330
- * accessing this storage gateway.
7635
+ /** @description Name of the DSI module to load by the GridFTP server when accessing
7636
+ * this storage gateway.
7331
7637
  * */
7332
7638
  load_dsi_module?: string | null;
7333
7639
  /** @description Admin-specified value when the **network_use** property's value is
@@ -7336,8 +7642,7 @@ export interface components {
7336
7642
  * */
7337
7643
  max_concurrency?: number;
7338
7644
  /** @description Admin-specified value when the **network_use** property's value is
7339
- * `custom`; otherwise the preset value for the specified
7340
- * **network_use**.
7645
+ * `custom`; otherwise the preset value for the specified **network_use**.
7341
7646
  * */
7342
7647
  max_parallelism?: number;
7343
7648
  /**
@@ -7347,8 +7652,8 @@ export interface components {
7347
7652
  *
7348
7653
  * * `normal`
7349
7654
  * - The default setting. Uses an average level of concurrency and
7350
- * parallelism. The levels depend on the number of physical
7351
- * servers in the endpoint.
7655
+ * parallelism. The levels depend on the number of physical servers
7656
+ * in the endpoint.
7352
7657
  * * `minimal`
7353
7658
  * - Uses a minimal level of concurrency and parallelism.
7354
7659
  * * `aggressive`
@@ -7365,13 +7670,11 @@ export interface components {
7365
7670
  /** @description Connector-specific storage policies */
7366
7671
  policies?: components["schemas"]["S3StoragePolicies_1_0_0"] | components["schemas"]["S3StoragePolicies_1_1_0"] | components["schemas"]["S3StoragePolicies_1_2_0"] | components["schemas"]["AzureBlobStoragePolicies_1_0_0"] | components["schemas"]["AzureBlobStoragePolicies_1_1_0"] | components["schemas"]["BlackPearlStoragePolicies_1_0_0"] | components["schemas"]["BoxStorage_1_0_0"] | components["schemas"]["BoxStorage_1_1_0"] | components["schemas"]["BoxStorage_1_2_0"] | components["schemas"]["CephStoragePolicies_1_0_0"] | components["schemas"]["DropboxStoragePolicies_1_0_0"] | components["schemas"]["GoogleCloudStoragePolicies_1_0_0"] | components["schemas"]["GoogleCloudStoragePolicies_1_1_0"] | components["schemas"]["GoogleDriveStoragePolicies_1_0_0"] | components["schemas"]["GoogleDriveStoragePolicies_1_1_0"] | components["schemas"]["HPSSStoragePolicies_1_0_0"] | components["schemas"]["HPSSStoragePolicies_1_1_0"] | components["schemas"]["IrodsStoragePolicies_1_0_0"] | components["schemas"]["OneDriveStoragePolicies_1_0_0"] | components["schemas"]["OneDriveStoragePolicies_1_1_0"] | components["schemas"]["PosixStoragePolicies_1_0_0"] | components["schemas"]["PosixStagingStoragePolicies_1_0_0"];
7367
7672
  /** @description Admin-specified value when the **network_use** property's value is
7368
- * `custom`; otherwise the preset value for the specified
7369
- * **network_use**.
7673
+ * `custom`; otherwise the preset value for the specified **network_use**.
7370
7674
  * */
7371
7675
  preferred_concurrency?: number;
7372
7676
  /** @description Admin-specified value when the **network_use** property's value is
7373
- * `custom`; otherwise the preset value for the specified
7374
- * **network_use**.
7677
+ * `custom`; otherwise the preset value for the specified **network_use**.
7375
7678
  * */
7376
7679
  preferred_parallelism?: number;
7377
7680
  /** @description Local POSIX user the GridFTP server should run as when accessing
@@ -7508,8 +7811,8 @@ export interface components {
7508
7811
  * @enum {string}
7509
7812
  */
7510
7813
  DATA_TYPE: "s3_storage_policies#1.0.0";
7511
- /** @description List of buckets not owned by the collection owner that will be shown in
7512
- * the root of collections created at the base of this storage gateway.
7814
+ /** @description List of buckets not owned by the collection owner that will be shown
7815
+ * in the root of collections created at the base of this storage gateway.
7513
7816
  * */
7514
7817
  s3_buckets?: string[];
7515
7818
  /**
@@ -7536,8 +7839,8 @@ export interface components {
7536
7839
  * @enum {string}
7537
7840
  */
7538
7841
  DATA_TYPE: "s3_storage_policies#1.1.0";
7539
- /** @description List of buckets not owned by the collection owner that will be shown in
7540
- * the root of collections created at the base of this storage gateway.
7842
+ /** @description List of buckets not owned by the collection owner that will be shown
7843
+ * in the root of collections created at the base of this storage gateway.
7541
7844
  * */
7542
7845
  s3_buckets?: string[];
7543
7846
  /**
@@ -7572,11 +7875,12 @@ export interface components {
7572
7875
  * @enum {string}
7573
7876
  */
7574
7877
  DATA_TYPE: "s3_storage_policies#1.2.0";
7575
- /** @description Allow users of this gateway to add multiple s3 IAM keys to their credentials
7878
+ /** @description Allow users of this gateway to add multiple s3 IAM keys to their
7879
+ * credentials
7576
7880
  * */
7577
7881
  s3_allow_multi_keys?: boolean;
7578
- /** @description List of buckets not owned by the collection owner that will be shown in
7579
- * the root of collections created at the base of this storage gateway.
7882
+ /** @description List of buckets not owned by the collection owner that will be shown
7883
+ * in the root of collections created at the base of this storage gateway.
7580
7884
  * */
7581
7885
  s3_buckets?: string[];
7582
7886
  /**
@@ -7620,8 +7924,7 @@ export interface components {
7620
7924
  * @enum {string}
7621
7925
  */
7622
7926
  DATA_TYPE: "s3_user_credential_policies#1.0.0";
7623
- /** @description Access Key ID to use with the S3 API to access your buckets and
7624
- * objects.
7927
+ /** @description Access Key ID to use with the S3 API to access your buckets and objects.
7625
7928
  * */
7626
7929
  s3_key_id?: string | null;
7627
7930
  /** @description Secret key to use with the S3 API to access your buckets and objects.
@@ -7642,8 +7945,7 @@ export interface components {
7642
7945
  * @enum {string}
7643
7946
  */
7644
7947
  DATA_TYPE: "s3_user_credential_policies#1.1.0";
7645
- /** @description Access Key ID to use with the S3 API to access your buckets and
7646
- * objects.
7948
+ /** @description Access Key ID to use with the S3 API to access your buckets and objects.
7647
7949
  * */
7648
7950
  s3_key_id?: string | null;
7649
7951
  /** @description Flag indicating the user acknowledges S3 operations will be charged to
@@ -7657,19 +7959,18 @@ export interface components {
7657
7959
  };
7658
7960
  /** S3KeysPrefixPaths_1_0_0 */
7659
7961
  S3KeysPrefixPaths_1_0_0: {
7660
- /** @description A list of matching prefix strings. When a S3 object is being accessed its virtual
7661
- * path <bucket>/<object> is matched against each string in this list. If the
7662
- * virtual path starts with a value in this list then the s3 keys in this object
7663
- * will be used.
7962
+ /** @description A list of matching prefix strings. When a S3 object is being accessed
7963
+ * its virtual path <bucket>/<object> is matched against each string in
7964
+ * this list. If the virtual path starts with a value in this list then
7965
+ * the s3 keys in this object will be used.
7664
7966
  * */
7665
7967
  path_prefixes: string[];
7666
- /** @description Access Key ID to use with the S3 API to access your buckets and
7667
- * objects.
7968
+ /** @description Access Key ID to use with the S3 API to access your buckets and objects.
7668
7969
  * */
7669
7970
  s3_key_id?: string | null;
7670
7971
  /** @description Secret key to use with the S3 API to access your buckets and objects.
7671
- * If set to null when calling PATCH it indicates that this entry should be
7672
- * deleted.
7972
+ * If set to null when calling PATCH it indicates that this entry should
7973
+ * be deleted.
7673
7974
  * */
7674
7975
  s3_secret_key?: string | null;
7675
7976
  };
@@ -7689,8 +7990,7 @@ export interface components {
7689
7990
  * @enum {string}
7690
7991
  */
7691
7992
  DATA_TYPE: "s3_user_credential_policies#1.2.0";
7692
- /** @description Access Key ID to use with the S3 API to access your buckets and
7693
- * objects.
7993
+ /** @description Access Key ID to use with the S3 API to access your buckets and objects.
7694
7994
  * */
7695
7995
  s3_key_id?: string | null;
7696
7996
  /** @description A list of path prefixes and S3 key pairs to use with them.
@@ -7860,8 +8160,8 @@ export interface components {
7860
8160
  * user's BlackPearl account
7861
8161
  * */
7862
8162
  bp_access_id_file?: string;
7863
- /** @description The URL of the S3 endpoint of the BlackPearl appliance
7864
- * to use to access collections on this Storage Gateway.
8163
+ /** @description The URL of the S3 endpoint of the BlackPearl appliance to use to
8164
+ * access collections on this Storage Gateway.
7865
8165
  * */
7866
8166
  s3_endpoint?: string;
7867
8167
  };
@@ -7999,8 +8299,8 @@ export interface components {
7999
8299
  */
8000
8300
  DATA_TYPE: "box_storage_policies#1.2.0";
8001
8301
  /** @description If true, allow users to access personal or external Box accounts.
8002
- * If false (the default), users must use the Box account which
8003
- * matches the username their Globus credential maps to.
8302
+ * If false (the default), users must use the Box account which matches
8303
+ * the username their Globus credential maps to.
8004
8304
  * */
8005
8305
  allow_any_account?: boolean;
8006
8306
  /** @description URL of the auth callback that must be set on the Box developer
@@ -8106,16 +8406,17 @@ export interface components {
8106
8406
  * @enum {string}
8107
8407
  */
8108
8408
  DATA_TYPE: "ceph_storage_policies#1.0.0";
8109
- /** @description Administrator key id used to authenticate with the ceph admin service
8110
- * to obtain user credentials.
8409
+ /** @description Administrator key id used to authenticate with the ceph admin
8410
+ * service to obtain user credentials.
8111
8411
  * */
8112
8412
  ceph_admin_key_id?: string;
8113
8413
  /** @description Administrator secret key used to authenticate with the ceph admin
8114
8414
  * service to obtain user credentials.
8115
8415
  * */
8116
8416
  ceph_admin_secret_key?: string;
8117
- /** @description List of buckets not owned by the collection owner that will be shown in
8118
- * the root of collections created at the base of this Storage Gateway.
8417
+ /** @description List of buckets not owned by the collection owner that will be
8418
+ * shown in the root of collections created at the base of this
8419
+ * Storage Gateway.
8119
8420
  * */
8120
8421
  s3_buckets?: string[];
8121
8422
  /** @description URL of the Ceph RADOS Gateway S3 API */
@@ -8176,8 +8477,8 @@ export interface components {
8176
8477
  * policy.
8177
8478
  * */
8178
8479
  secret: string | null;
8179
- /** @description User API Rate Limit associated with this client ID in operations per
8180
- * second per user.
8480
+ /** @description User API Rate Limit associated with this client ID in operations
8481
+ * per second per user.
8181
8482
  * */
8182
8483
  user_api_rate_limit?: number;
8183
8484
  };
@@ -8256,12 +8557,12 @@ export interface components {
8256
8557
  * Google credentials.
8257
8558
  * */
8258
8559
  readonly auth_callback?: string;
8259
- /** @description The list of Google Cloud Storage buckets which the Storage Gateway is
8260
- * allowed to access, as well as the list of buckets that will be shown in
8261
- * root level directory listings. If this list is unset, bucket access is
8262
- * unrestricted and all non public credential accessible buckets will be
8263
- * shown in root level directory listings. The value is a list of bucket
8264
- * names.
8560
+ /** @description The list of Google Cloud Storage buckets which the Storage Gateway
8561
+ * is allowed to access, as well as the list of buckets that will be
8562
+ * shown in root level directory listings. If this list is unset,
8563
+ * bucket access is unrestricted and all non public credential accessible
8564
+ * buckets will be shown in root level directory listings. The value
8565
+ * is a list of bucket names.
8265
8566
  * */
8266
8567
  buckets?: string[] | null;
8267
8568
  /** @description Client ID registered with the Google Application console to access
@@ -8277,7 +8578,8 @@ export interface components {
8277
8578
  * in this policy.
8278
8579
  * */
8279
8580
  secret: string | null;
8280
- /** @description Service account key to use when authenticating all storage access */
8581
+ /** @description Service account key to use when authenticating all storage access
8582
+ * */
8281
8583
  service_account_key?: Record<string, unknown> | null;
8282
8584
  /** @description Flag indicating whether users must register a credential. If true (or
8283
8585
  * if this property is missing), this storage gateway is configured for
@@ -8309,12 +8611,12 @@ export interface components {
8309
8611
  * Google credentials.
8310
8612
  * */
8311
8613
  readonly auth_callback?: string;
8312
- /** @description The list of Google Cloud Storage buckets which the Storage Gateway is
8313
- * allowed to access, as well as the list of buckets that will be shown in
8314
- * root level directory listings. If this list is unset, bucket access is
8315
- * unrestricted and all non public credential accessible buckets will be
8316
- * shown in root level directory listings. The value is a list of bucket
8317
- * names.
8614
+ /** @description The list of Google Cloud Storage buckets which the Storage Gateway
8615
+ * is allowed to access, as well as the list of buckets that will be
8616
+ * shown in root level directory listings. If this list is unset,
8617
+ * bucket access is unrestricted and all non public credential accessible
8618
+ * buckets will be shown in root level directory listings. The value
8619
+ * is a list of bucket names.
8318
8620
  * */
8319
8621
  buckets?: string[] | null;
8320
8622
  /** @description Client ID registered with the Google Application console to access
@@ -8330,7 +8632,8 @@ export interface components {
8330
8632
  * in this policy.
8331
8633
  * */
8332
8634
  secret: string | null;
8333
- /** @description Service account key to use when authenticating all storage access */
8635
+ /** @description Service account key to use when authenticating all storage access
8636
+ * */
8334
8637
  service_account_key?: Record<string, unknown> | null;
8335
8638
  /** @description Flag indicating whether users must register a credential. If true (or
8336
8639
  * if this property is missing), this storage gateway is configured for
@@ -8395,7 +8698,9 @@ export interface components {
8395
8698
  * Cloud Storage API
8396
8699
  * */
8397
8700
  refresh_token?: string | null;
8398
- /** @description List of OAuth2 scopes associated with the tokens in this credential */
8701
+ /** @description "
8702
+ * List of OAuth2 scopes associated with the tokens in this credential
8703
+ * */
8399
8704
  scopes?: string[];
8400
8705
  /** @description OpenID Connect subject property of this credential */
8401
8706
  sub?: string;
@@ -8426,8 +8731,8 @@ export interface components {
8426
8731
  * Google Drive.
8427
8732
  * */
8428
8733
  client_id: string | null;
8429
- /** @description Secret created to access access Google Drive with the client_id in this
8430
- * policy.
8734
+ /** @description Secret created to access access Google Drive with the client_id
8735
+ * in this policy.
8431
8736
  * */
8432
8737
  secret: string | null;
8433
8738
  /** @description User API Rate quota associated with this client ID */
@@ -8459,8 +8764,8 @@ export interface components {
8459
8764
  * Google Drive.
8460
8765
  * */
8461
8766
  client_id: string | null;
8462
- /** @description Secret created to access access Google Drive with the client_id in this
8463
- * policy.
8767
+ /** @description Secret created to access access Google Drive with the client_id
8768
+ * in this policy.
8464
8769
  * */
8465
8770
  secret: string | null;
8466
8771
  /** @description User API Rate quota associated with this client ID */
@@ -8528,15 +8833,16 @@ export interface components {
8528
8833
  */
8529
8834
  DATA_TYPE: "hpss_storage_policies#1.0.0";
8530
8835
  /**
8531
- * @description The type of authentication the connector will perform when logging into HPSS
8836
+ * @description The type of authentication the connector will perform when logging
8837
+ * into HPSS
8532
8838
  *
8533
8839
  * @enum {string}
8534
8840
  */
8535
8841
  authentication_mech: "krb5" | "unix";
8536
8842
  /**
8537
8843
  * @description Authenticator used with authentication mech to perform authentication
8538
- * to HPSS. Format is: "<auth_type>:<auth_file>" where <auth_type> is one
8539
- * of "auth_keytab" or "auth_keyfile".
8844
+ * to HPSS. Format is: "<auth_type>:<auth_file>" where <auth_type>
8845
+ * is one of "auth_keytab" or "auth_keyfile".
8540
8846
  *
8541
8847
  * @example auth_keytab:/var/hpss/etc/gridftp.keytab
8542
8848
  */
@@ -8556,23 +8862,24 @@ export interface components {
8556
8862
  */
8557
8863
  DATA_TYPE: "hpss_storage_policies#1.1.0";
8558
8864
  /**
8559
- * @description The type of authentication the connector will perform when logging into HPSS
8865
+ * @description The type of authentication the connector will perform when logging
8866
+ * into HPSS
8560
8867
  *
8561
8868
  * @enum {string}
8562
8869
  */
8563
8870
  authentication_mech: "krb5" | "unix";
8564
8871
  /**
8565
8872
  * @description Authenticator used with authentication mech to perform authentication
8566
- * to HPSS. Format is: "<auth_type>:<auth_file>" where <auth_type> is one
8567
- * of "auth_keytab" or "auth_keyfile".
8873
+ * to HPSS. Format is: "<auth_type>:<auth_file>" where <auth_type>
8874
+ * is one of "auth_keytab" or "auth_keyfile".
8568
8875
  *
8569
8876
  * @example auth_keytab:/var/hpss/etc/gridftp.keytab
8570
8877
  */
8571
8878
  authenticator: string;
8572
- /** @description Name of the HPSS user in the keytab file that the GridFTP server will use
8573
- * to authenticate to HPSS. This user must have the ability to switch to another
8574
- * HPSS user. Defaults to 'hpssftp' which is also handled special by HPSS with
8575
- * regards to the gate keeper.
8879
+ /** @description Name of the HPSS user in the keytab file that the GridFTP server will
8880
+ * use to authenticate to HPSS. This user must have the ability to switch
8881
+ * to another HPSS user. Defaults to 'hpssftp' which is also handled special
8882
+ * by HPSS with regards to the gate keeper.
8576
8883
  * */
8577
8884
  login_name?: string;
8578
8885
  /** @description Flag that indicates if checksums should be stored within UDAs so that
@@ -8681,12 +8988,13 @@ export interface components {
8681
8988
  * @enum {string}
8682
8989
  */
8683
8990
  DATA_TYPE: "onedrive_storage_policies#1.0.0";
8684
- /** @description URL of the auth callback that must be registered on the Microsoft
8685
- * API console for the application client_id in order to process
8686
- * Microsoft credentials.
8991
+ /** @description URL of the auth callback that must be registered on the Microsoft API
8992
+ * console for the application client_id in order to process Microsoft
8993
+ * credentials.
8687
8994
  * */
8688
8995
  readonly auth_callback?: string;
8689
- /** @description Client ID registered with the Azure console to access OneDrive */
8996
+ /** @description Client ID registered with the Azure console to access OneDrive
8997
+ * */
8690
8998
  client_id: string | null;
8691
8999
  /** @description Secret created in the Azure console to access OneDrive with the
8692
9000
  * client_id in this policy.
@@ -8718,12 +9026,13 @@ export interface components {
8718
9026
  * matches the username their Globus credential maps to.
8719
9027
  * */
8720
9028
  allow_any_account?: boolean;
8721
- /** @description URL of the auth callback that must be registered on the Microsoft
8722
- * API console for the application client_id in order to process
8723
- * Microsoft credentials.
9029
+ /** @description URL of the auth callback that must be registered on the Microsoft API
9030
+ * console for the application client_id in order to process Microsoft
9031
+ * credentials.
8724
9032
  * */
8725
9033
  readonly auth_callback?: string;
8726
- /** @description Client ID registered with the Azure console to access OneDrive */
9034
+ /** @description Client ID registered with the Azure console to access OneDrive
9035
+ * */
8727
9036
  client_id: string | null;
8728
9037
  /** @description Secret created in the Azure console to access OneDrive with the
8729
9038
  * client_id in this policy.
@@ -9034,8 +9343,11 @@ export interface components {
9034
9343
  *
9035
9344
  * Version 1.15.0 adds the associated_flow_policy property to the collection.
9036
9345
  *
9346
+ * Version 1.16.0 adds the preserve_modtime and https_methods property to the
9347
+ * collection.
9348
+ *
9037
9349
  */
9038
- Collection: components["schemas"]["Collection_1_0_0"] | components["schemas"]["Collection_1_1_0"] | components["schemas"]["Collection_1_2_0"] | components["schemas"]["Collection_1_3_0"] | components["schemas"]["Collection_1_4_0"] | components["schemas"]["Collection_1_5_0"] | components["schemas"]["Collection_1_6_0"] | components["schemas"]["Collection_1_7_0"] | components["schemas"]["Collection_1_8_0"] | components["schemas"]["Collection_1_9_0"] | components["schemas"]["Collection_1_10_0"] | components["schemas"]["Collection_1_11_0"] | components["schemas"]["Collection_1_12_0"] | components["schemas"]["Collection_1_13_0"] | components["schemas"]["Collection_1_14_0"] | components["schemas"]["Collection_1_15_0"];
9350
+ Collection: components["schemas"]["Collection_1_0_0"] | components["schemas"]["Collection_1_1_0"] | components["schemas"]["Collection_1_2_0"] | components["schemas"]["Collection_1_3_0"] | components["schemas"]["Collection_1_4_0"] | components["schemas"]["Collection_1_5_0"] | components["schemas"]["Collection_1_6_0"] | components["schemas"]["Collection_1_7_0"] | components["schemas"]["Collection_1_8_0"] | components["schemas"]["Collection_1_9_0"] | components["schemas"]["Collection_1_10_0"] | components["schemas"]["Collection_1_11_0"] | components["schemas"]["Collection_1_12_0"] | components["schemas"]["Collection_1_13_0"] | components["schemas"]["Collection_1_14_0"] | components["schemas"]["Collection_1_15_0"] | components["schemas"]["Collection_1_16_0"];
9039
9351
  /**
9040
9352
  * CollectionNotFound
9041
9353
  * @description Error details when a mapped collection no longer exists when accessing a