@globus/sdk 2.6.0 → 2.7.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 (36) hide show
  1. package/cjs/lib/services/transfer/index.d.ts +1 -0
  2. package/cjs/lib/services/transfer/index.d.ts.map +1 -1
  3. package/cjs/lib/services/transfer/index.js +2 -1
  4. package/cjs/lib/services/transfer/index.js.map +1 -1
  5. package/cjs/lib/services/transfer/service/collection-bookmarks.d.ts +64 -0
  6. package/cjs/lib/services/transfer/service/collection-bookmarks.d.ts.map +1 -0
  7. package/cjs/lib/services/transfer/service/collection-bookmarks.js +59 -0
  8. package/cjs/lib/services/transfer/service/collection-bookmarks.js.map +1 -0
  9. package/cjs/lib/services/transfer/service/endpoint.d.ts +127 -13
  10. package/cjs/lib/services/transfer/service/endpoint.d.ts.map +1 -1
  11. package/cjs/lib/services/transfer/service/endpoint.js +40 -1
  12. package/cjs/lib/services/transfer/service/endpoint.js.map +1 -1
  13. package/cjs/lib/services/transfer/service/task.d.ts +1 -1
  14. package/cjs/lib/services/transfer/types.d.ts +215 -0
  15. package/cjs/lib/services/transfer/types.d.ts.map +1 -1
  16. package/cjs/lib/services/types.d.ts +4 -0
  17. package/cjs/lib/services/types.d.ts.map +1 -1
  18. package/esm/lib/services/transfer/index.d.ts +1 -0
  19. package/esm/lib/services/transfer/index.d.ts.map +1 -1
  20. package/esm/lib/services/transfer/index.js +1 -0
  21. package/esm/lib/services/transfer/index.js.map +1 -1
  22. package/esm/lib/services/transfer/service/collection-bookmarks.d.ts +64 -0
  23. package/esm/lib/services/transfer/service/collection-bookmarks.d.ts.map +1 -0
  24. package/esm/lib/services/transfer/service/collection-bookmarks.js +56 -0
  25. package/esm/lib/services/transfer/service/collection-bookmarks.js.map +1 -0
  26. package/esm/lib/services/transfer/service/endpoint.d.ts +127 -13
  27. package/esm/lib/services/transfer/service/endpoint.d.ts.map +1 -1
  28. package/esm/lib/services/transfer/service/endpoint.js +39 -0
  29. package/esm/lib/services/transfer/service/endpoint.js.map +1 -1
  30. package/esm/lib/services/transfer/service/task.d.ts +1 -1
  31. package/esm/lib/services/transfer/types.d.ts +215 -0
  32. package/esm/lib/services/transfer/types.d.ts.map +1 -1
  33. package/esm/lib/services/types.d.ts +4 -0
  34. package/esm/lib/services/types.d.ts.map +1 -1
  35. package/package.json +1 -1
  36. package/umd/globus.production.js +1 -1
@@ -17,5 +17,6 @@ export * as taskSubmission from './service/task-submission.js';
17
17
  export * as endpoint from './service/endpoint.js';
18
18
  export * as task from './service/task.js';
19
19
  export * as access from './service/access.js';
20
+ export * as collectionBookmarks from './service/collection-bookmarks.js';
20
21
  export * as endpointManager from './service/endpoint-manager/index.js';
21
22
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/services/transfer/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,MAAM,iBAAW,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,CAAC;AAC1B,OAAO,KAAK,cAAc,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,cAAc,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAE9C,OAAO,KAAK,eAAe,MAAM,qCAAqC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/services/transfer/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,MAAM,iBAAW,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,CAAC;AAC1B,OAAO,KAAK,cAAc,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,cAAc,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,mBAAmB,MAAM,mCAAmC,CAAC;AAEzE,OAAO,KAAK,eAAe,MAAM,qCAAqC,CAAC"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.endpointManager = exports.access = exports.task = exports.endpoint = exports.taskSubmission = exports.fileOperations = exports.endpointSearch = exports.CONFIG = void 0;
3
+ exports.endpointManager = exports.collectionBookmarks = exports.access = exports.task = exports.endpoint = exports.taskSubmission = exports.fileOperations = exports.endpointSearch = exports.CONFIG = void 0;
4
4
  const tslib_1 = require("tslib");
5
5
  /**
6
6
  * @description A wrapper around the Globus Transfer service.
@@ -21,5 +21,6 @@ exports.taskSubmission = tslib_1.__importStar(require("./service/task-submission
21
21
  exports.endpoint = tslib_1.__importStar(require("./service/endpoint.js"));
22
22
  exports.task = tslib_1.__importStar(require("./service/task.js"));
23
23
  exports.access = tslib_1.__importStar(require("./service/access.js"));
24
+ exports.collectionBookmarks = tslib_1.__importStar(require("./service/collection-bookmarks.js"));
24
25
  exports.endpointManager = tslib_1.__importStar(require("./service/endpoint-manager/index.js"));
25
26
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/services/transfer/index.ts"],"names":[],"mappings":";;;;AAAA;;;;;GAKG;AACH,8DAAwC;AAExC,qEAA8D;AAQrD,+FARA,mCAAc,OAQA;AANvB;;;GAGG;AACU,QAAA,MAAM,GAAG,QAAQ,CAAC;AAG/B,uFAA+D;AAC/D,uFAA+D;AAC/D,0EAAkD;AAClD,kEAA0C;AAC1C,sEAA8C;AAE9C,+FAAuE"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/services/transfer/index.ts"],"names":[],"mappings":";;;;AAAA;;;;;GAKG;AACH,8DAAwC;AAExC,qEAA8D;AAQrD,+FARA,mCAAc,OAQA;AANvB;;;GAGG;AACU,QAAA,MAAM,GAAG,QAAQ,CAAC;AAG/B,uFAA+D;AAC/D,uFAA+D;AAC/D,0EAAkD;AAClD,kEAA0C;AAC1C,sEAA8C;AAC9C,iGAAyE;AAEzE,+FAAuE"}
@@ -0,0 +1,64 @@
1
+ /// <reference types="@globus/types" />
2
+ /// <reference types="@globus/types/auth" />
3
+ /// <reference types="@globus/types/transfer" />
4
+ /// <reference types="@globus/types/transfer" />
5
+ /// <reference types="@globus/types/search" />
6
+ import type { JSONFetchResponse } from '../../types.js';
7
+ /**
8
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#get_list_of_bookmarks
9
+ */
10
+ export declare const getAll: (options?: ({
11
+ query?: undefined;
12
+ payload?: undefined;
13
+ } & import("../../types.js").BaseServiceMethodOptions) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<Globus.Transfer.BookmarkListDocument>>;
14
+ /**
15
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#create_bookmark
16
+ */
17
+ export declare const create: (options: ({
18
+ payload: Partial<Globus.Transfer.BookmarkDocument>;
19
+ } & import("../../types.js").BaseServiceMethodOptions) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<Globus.Transfer.BookmarkDocument>>;
20
+ /**
21
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#get_bookmark_by_id
22
+ */
23
+ export declare const get: (bookmark_id: string, options?: ({
24
+ query?: undefined;
25
+ payload?: undefined;
26
+ } & {
27
+ query?: {
28
+ [key: string]: string | number | boolean | (string | number | null | undefined)[] | null | undefined;
29
+ } | undefined;
30
+ headers?: import("../../types.js").Headers | undefined;
31
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<Globus.Transfer.BookmarkDocument>>;
32
+ /**
33
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#update_bookmark
34
+ */
35
+ export declare const update: (bookmark_id: string, options: ({
36
+ query?: undefined;
37
+ payload: Partial<Globus.Transfer.BookmarkDocument> & {
38
+ name: string;
39
+ };
40
+ } & {
41
+ query?: {
42
+ [key: string]: string | number | boolean | (string | number | null | undefined)[] | null | undefined;
43
+ } | undefined;
44
+ headers?: import("../../types.js").Headers | undefined;
45
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<Globus.Transfer.BookmarkDocument>>;
46
+ /**
47
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#delete_bookmark_by_id
48
+ */
49
+ export declare const remove: (bookmark_id: string, options?: ({
50
+ query?: undefined;
51
+ payload?: undefined;
52
+ } & {
53
+ query?: {
54
+ [key: string]: string | number | boolean | (string | number | null | undefined)[] | null | undefined;
55
+ } | undefined;
56
+ headers?: import("../../types.js").Headers | undefined;
57
+ }) | undefined, sdkOptions?: import("../../types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<{
58
+ DATA_TYPE: 'result';
59
+ code: 'Deleted';
60
+ message: string;
61
+ resource: `/bookmark/${string}`;
62
+ request_id: string;
63
+ }>>;
64
+ //# sourceMappingURL=collection-bookmarks.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection-bookmarks.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/services/transfer/service/collection-bookmarks.ts"],"names":[],"mappings":";;;;;AAGA,OAAO,KAAK,EAEV,iBAAiB,EAElB,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,MAAM;;;qIAGhB,QAAQ,kBAAkB,OAAO,QAAQ,CAAC,oBAAoB,CAAC,CAahE,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,MAAM;aAeR,QAAQ,OAAO,QAAQ,CAAC,gBAAgB,CAAC;qIAZjD,QAAQ,kBAAkB,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAa5D,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,GAAG;;;;;;;;iFAIb,QAAQ,kBAAkB,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAgB7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;;aAmBN,QAAQ,OAAO,QAAQ,CAAC,gBAAgB,CAAC,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;;;;;iFAftE,QAAQ,kBAAkB,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAiB7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;iFAIhB,QACD,kBAAkB;IAChB,SAAS,EAAE,QAAQ,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,aAAa,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC,CAkBH,CAAC"}
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.remove = exports.update = exports.get = exports.create = exports.getAll = void 0;
4
+ const shared_js_1 = require("../../shared.js");
5
+ const config_js_1 = require("../config.js");
6
+ /**
7
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#get_list_of_bookmarks
8
+ */
9
+ exports.getAll = function (options, sdkOptions) {
10
+ return (0, shared_js_1.serviceRequest)({
11
+ service: config_js_1.ID,
12
+ scope: config_js_1.SCOPES.ALL,
13
+ path: `/v0.10/bookmark_list`,
14
+ }, options, sdkOptions);
15
+ };
16
+ /**
17
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#create_bookmark
18
+ */
19
+ exports.create = function (options, sdkOptions) {
20
+ return (0, shared_js_1.serviceRequest)({
21
+ service: config_js_1.ID,
22
+ scope: config_js_1.SCOPES.ALL,
23
+ path: `/v0.10/bookmark`,
24
+ method: shared_js_1.HTTP_METHODS.POST,
25
+ }, options, sdkOptions);
26
+ };
27
+ /**
28
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#get_bookmark_by_id
29
+ */
30
+ exports.get = function (bookmark_id, options, sdkOptions) {
31
+ return (0, shared_js_1.serviceRequest)({
32
+ service: config_js_1.ID,
33
+ scope: config_js_1.SCOPES.ALL,
34
+ path: `/v0.10/bookmark/${bookmark_id}`,
35
+ }, options, sdkOptions);
36
+ };
37
+ /**
38
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#update_bookmark
39
+ */
40
+ exports.update = function (bookmark_id, options, sdkOptions) {
41
+ return (0, shared_js_1.serviceRequest)({
42
+ service: config_js_1.ID,
43
+ scope: config_js_1.SCOPES.ALL,
44
+ path: `/v0.10/bookmark/${bookmark_id}`,
45
+ method: shared_js_1.HTTP_METHODS.PUT,
46
+ }, options, sdkOptions);
47
+ };
48
+ /**
49
+ * @see https://docs.globus.org/api/transfer/collection_bookmarks/#delete_bookmark_by_id
50
+ */
51
+ exports.remove = function (bookmark_id, options, sdkOptions) {
52
+ return (0, shared_js_1.serviceRequest)({
53
+ service: config_js_1.ID,
54
+ scope: config_js_1.SCOPES.ALL,
55
+ path: `/v0.10/bookmark/${bookmark_id}`,
56
+ method: shared_js_1.HTTP_METHODS.DELETE,
57
+ }, options, sdkOptions);
58
+ };
59
+ //# sourceMappingURL=collection-bookmarks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection-bookmarks.js","sourceRoot":"","sources":["../../../../../../src/lib/services/transfer/service/collection-bookmarks.ts"],"names":[],"mappings":";;;AAAA,+CAA+D;AAC/D,4CAA0C;AAQ1C;;GAEG;AACU,QAAA,MAAM,GAAG,UACpB,OAAQ,EACR,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,sBAAsB;KAC7B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAGE,CAAC;AAEH;;GAEG;AACU,QAAA,MAAM,GAAG,UACpB,OAAO,EACP,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,iBAAiB;QACvB,MAAM,EAAE,wBAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAEE,CAAC;AAEH;;GAEG;AACU,QAAA,GAAG,GAAG,UACjB,WAAW,EACX,OAAQ,EACR,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,WAAW,EAAE;KACvC,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAEF;;GAEG;AACU,QAAA,MAAM,GAAG,UACpB,WAAW,EACX,OAAO,EACP,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,WAAW,EAAE;QACtC,MAAM,EAAE,wBAAY,CAAC,GAAG;KACzB,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAEF;;GAEG;AACU,QAAA,MAAM,GAAG,UACpB,WAAW,EACX,OAAQ,EACR,UAAW;IAUX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,WAAW,EAAE;QACtC,MAAM,EAAE,wBAAY,CAAC,MAAM;KAC5B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC"}
@@ -1,9 +1,6 @@
1
- /// <reference types="@globus/types" />
2
- /// <reference types="@globus/types/auth" />
3
- /// <reference types="@globus/types/transfer" />
4
- /// <reference types="@globus/types/transfer" />
5
- /// <reference types="@globus/types/search" />
6
1
  import type { JSONFetchResponse } from '../../../services/types.js';
2
+ import type { Operations } from '../types.js';
3
+ export type GetResponse = Operations['GetEndpoint']['response'];
7
4
  /**
8
5
  * Fetch an endpoint by its UUID.
9
6
  */
@@ -15,7 +12,130 @@ export declare const get: (endpoint_xid: string, options?: ({
15
12
  [key: string]: string | number | boolean | (string | number | null | undefined)[] | null | undefined;
16
13
  } | undefined;
17
14
  headers?: import("../../../services/types.js").Headers | undefined;
18
- }) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<Globus.Transfer.EndpointDocument>>;
15
+ }) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<GetResponse>>;
16
+ export type CreatePayload = Operations['CreateEndpoint']['payload'];
17
+ export type CreateResponse = Operations['CreateEndpoint']['response'];
18
+ /**
19
+ * Create a Globus Connect Personal guest collection.
20
+ * As of 2024-04-17, this method (and the Transfer API) only supports creating Globus Connect Personal guest collections.
21
+ *
22
+ * Globus Connect Personal mapped collections are created from the Globus Connect Personal application.
23
+ * All GCSv5 collections should be created using Globus Connect Server (i.e. {@link "@globus/sdk".gcs.collections.create | `gcs.collections.create`}).
24
+ *
25
+ * @see https://docs.globus.org/api/transfer/gcp_management/#create_guest_collection
26
+ */
27
+ export declare const create: (options?: ({
28
+ payload?: (Partial<Pick<{
29
+ DATA_TYPE: "endpoint";
30
+ DATA?: {
31
+ DATA_TYPE: "server";
32
+ id: number;
33
+ hostname: string | null;
34
+ port: number | null;
35
+ scheme: "ftp" | "gsiftp" | null;
36
+ subject: string | null;
37
+ incoming_data_port_start: number | null;
38
+ incoming_data_port_end: number | null;
39
+ outgoing_data_port_start: number | null;
40
+ outgoing_data_port_end: number | null;
41
+ uri: string;
42
+ is_connected: boolean;
43
+ is_paused: boolean;
44
+ }[] | undefined;
45
+ id: string;
46
+ display_name: string;
47
+ organization: string | null;
48
+ department: string | null;
49
+ keywords: string | null;
50
+ name: string | null;
51
+ canonical_name: string;
52
+ username: string;
53
+ owner_id: string;
54
+ owner_string: string;
55
+ description: string | null;
56
+ contact_email: string | null;
57
+ contact_info: string | null;
58
+ info_link: string | null;
59
+ user_message: string | null;
60
+ user_message_link: string | null;
61
+ public: boolean;
62
+ subscription_id: string | null;
63
+ french_english_bilingual: boolean;
64
+ default_directory: string | null;
65
+ force_encryption: boolean;
66
+ disable_verify: boolean;
67
+ disable_anonymous_writes: boolean;
68
+ entity_type: "GCSv5_endpoint" | "GCSv5_mapped_collection" | "GCSv5_guest_collection" | "GCP_mapped_collection" | "GCP_guest_collection";
69
+ force_verify: boolean;
70
+ mfa_required: boolean;
71
+ expire_time: null;
72
+ expires_in: null;
73
+ activated: boolean;
74
+ myproxy_server: string | null;
75
+ myproxy_dn: string | null;
76
+ oauth_server: string | null;
77
+ requester_pays: boolean;
78
+ is_globus_connect: boolean;
79
+ gcs_version: string | null;
80
+ globus_connect_setup_key: string | null;
81
+ host_endpoint: string | null;
82
+ host_endpoint_id: string | null;
83
+ host_endpoint_display_name: string | null;
84
+ host_path: string | null;
85
+ s3_url: null;
86
+ s3_owner_activated: false;
87
+ acl_available: boolean;
88
+ acl_editable: boolean;
89
+ in_use: boolean;
90
+ my_effective_roles: (("administrator" | "access_manager" | "activity_manager" | "activity_monitor") | "restricted_administrator")[];
91
+ gcp_connected: boolean | null;
92
+ gcp_paused: boolean | null;
93
+ network_use: "normal" | "minimal" | "aggressive" | "custom" | null;
94
+ location: string | null;
95
+ max_concurrency: number | null;
96
+ preferred_concurrency: number | null;
97
+ max_parallelism: number | null;
98
+ preferred_parallelism: number | null;
99
+ local_user_info_available: boolean | null;
100
+ https_server: string | null;
101
+ gcs_manager_url: `${string}://${string}` | null;
102
+ tlsftp_server: `tlsftp://${string}:${string}` | null;
103
+ high_assurance: boolean;
104
+ acl_max_expiration_period_mins: number | null;
105
+ authentication_timeout_mins: number | null;
106
+ authentication_assurance_timeout: number;
107
+ non_functional: boolean;
108
+ non_functional_endpoint_id: string | null;
109
+ non_functional_endpoint_display_name: string | null;
110
+ mapped_collection_id: string | null;
111
+ mapped_collection_display_name: string | null;
112
+ last_accessed_time: string | null;
113
+ }, "contact_email" | "contact_info" | "default_directory" | "department" | "description" | "disable_verify" | "display_name" | "force_encryption" | "info_link" | "keywords" | "organization" | "acl_max_expiration_period_mins" | "owner_string">> & {
114
+ DATA_TYPE?: "shared_endpoint" | undefined;
115
+ host_endpoint_id: string;
116
+ host_path: string;
117
+ }) | undefined;
118
+ } & import("../../../services/types.js").BaseServiceMethodOptions) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<CreateResponse>>;
119
+ export type UpdatePayload = Operations['UpdateEndpoint']['payload'];
120
+ export type UpdateResponse = Operations['UpdateEndpoint']['response'];
121
+ /**
122
+ * Update a Globus Connect Personal collection.
123
+ * As of 2024-04-17, this method (and the Transfer API) only supports updating Globus Connect Personal collections.
124
+ *
125
+ * All GCSv5 collections should be updated using Globus Connect Server (i.e. {@link "@globus/sdk".gcs.collections.update | `gcs.collections.update`}).
126
+ *
127
+ * @see https://docs.globus.org/api/transfer/gcp_management/#update_collection_by_id
128
+ */
129
+ export declare const update: (endpoint_xid: string, options?: ({
130
+ payload: UpdatePayload;
131
+ query?: undefined;
132
+ } & {
133
+ query?: {
134
+ [key: string]: string | number | boolean | (string | number | null | undefined)[] | null | undefined;
135
+ } | undefined;
136
+ headers?: import("../../../services/types.js").Headers | undefined;
137
+ }) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<UpdateResponse>>;
138
+ export type RemoveResponse = Operations['RemoveEndpoint']['response'];
19
139
  /**
20
140
  * Delete a Globus Connect Personal entity by its UUID.
21
141
  * As of 2024-01-08, this method (and the Transfer API) only supports deleting Globus Connect Personal entities.
@@ -32,11 +152,5 @@ export declare const remove: (endpoint_xid: string, options?: ({
32
152
  [key: string]: string | number | boolean | (string | number | null | undefined)[] | null | undefined;
33
153
  } | undefined;
34
154
  headers?: import("../../../services/types.js").Headers | undefined;
35
- }) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<{
36
- DATA_TYPE: 'result';
37
- code: 'Deleted';
38
- message: string;
39
- request_id: string;
40
- resource: `/endpoint/${string}`;
41
- }>>;
155
+ }) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<RemoveResponse>>;
42
156
  //# sourceMappingURL=endpoint.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/services/transfer/service/endpoint.ts"],"names":[],"mappings":";;;;;AAGA,OAAO,KAAK,EAAgC,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAElG;;GAEG;AACH,eAAO,MAAM,GAAG;;;;;;;;6FAIb,QAAQ,kBAAkB,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAgB7D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM;;;;;;;;6FAIhB,QACD,kBAAkB;IAChB,SAAS,EAAE,QAAQ,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,aAAa,MAAM,EAAE,CAAC;CACjC,CAAC,CAkBH,CAAC"}
1
+ {"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/services/transfer/service/endpoint.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEV,iBAAiB,EAElB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,CAAC;AAChE;;GAEG;AACH,eAAO,MAAM,GAAG;;;;;;;;6FAIb,QAAQ,kBAAkB,WAAW,CAAC,CAgBxC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC;AACpE,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;AACtE;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6JAAqC,QAAQ,kBAAkB,cAAc,CAAC,CAiB/F,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC;AACpE,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;AACtE;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM;aAsBN,aAAa;;;;;;;6FAlBvB,QAAQ,kBAAkB,cAAc,CAAC,CAqB3C,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;AACtE;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM;;;;;;;;6FAIhB,QAAQ,kBAAkB,cAAc,CAAC,CAiB3C,CAAC"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.remove = exports.get = void 0;
3
+ exports.remove = exports.update = exports.create = exports.get = void 0;
4
4
  const shared_js_1 = require("../../shared.js");
5
5
  const config_js_1 = require("../config.js");
6
6
  /**
@@ -13,6 +13,45 @@ exports.get = function (endpoint_xid, options, sdkOptions) {
13
13
  path: `/v0.10/endpoint/${endpoint_xid}`,
14
14
  }, options, sdkOptions);
15
15
  };
16
+ /**
17
+ * Create a Globus Connect Personal guest collection.
18
+ * As of 2024-04-17, this method (and the Transfer API) only supports creating Globus Connect Personal guest collections.
19
+ *
20
+ * Globus Connect Personal mapped collections are created from the Globus Connect Personal application.
21
+ * All GCSv5 collections should be created using Globus Connect Server (i.e. {@link "@globus/sdk".gcs.collections.create | `gcs.collections.create`}).
22
+ *
23
+ * @see https://docs.globus.org/api/transfer/gcp_management/#create_guest_collection
24
+ */
25
+ exports.create = function (options, sdkOptions) {
26
+ if (options === null || options === void 0 ? void 0 : options.payload) {
27
+ Object.assign(options.payload, { DATA_TYPE: 'shared_endpoint' });
28
+ }
29
+ return (0, shared_js_1.serviceRequest)({
30
+ service: config_js_1.ID,
31
+ scope: config_js_1.SCOPES.ALL,
32
+ path: '/v0.10/shared_endpoint',
33
+ method: shared_js_1.HTTP_METHODS.POST,
34
+ }, options, sdkOptions);
35
+ };
36
+ /**
37
+ * Update a Globus Connect Personal collection.
38
+ * As of 2024-04-17, this method (and the Transfer API) only supports updating Globus Connect Personal collections.
39
+ *
40
+ * All GCSv5 collections should be updated using Globus Connect Server (i.e. {@link "@globus/sdk".gcs.collections.update | `gcs.collections.update`}).
41
+ *
42
+ * @see https://docs.globus.org/api/transfer/gcp_management/#update_collection_by_id
43
+ */
44
+ exports.update = function (endpoint_xid, options, sdkOptions) {
45
+ if (options === null || options === void 0 ? void 0 : options.payload) {
46
+ Object.assign(options.payload, { DATA_TYPE: 'endpoint' });
47
+ }
48
+ return (0, shared_js_1.serviceRequest)({
49
+ service: config_js_1.ID,
50
+ scope: config_js_1.SCOPES.ALL,
51
+ path: `/v0.10/endpoint/${endpoint_xid}`,
52
+ method: shared_js_1.HTTP_METHODS.PUT,
53
+ }, options, sdkOptions);
54
+ };
16
55
  /**
17
56
  * Delete a Globus Connect Personal entity by its UUID.
18
57
  * As of 2024-01-08, this method (and the Transfer API) only supports deleting Globus Connect Personal entities.
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint.js","sourceRoot":"","sources":["../../../../../../src/lib/services/transfer/service/endpoint.ts"],"names":[],"mappings":";;;AAAA,+CAA+D;AAC/D,4CAA0C;AAI1C;;GAEG;AACU,QAAA,GAAG,GAAG,UACjB,YAAY,EACZ,OAAQ,EACR,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,YAAY,EAAE;KACxC,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAEF;;;;;;;GAOG;AACU,QAAA,MAAM,GAAG,UACpB,YAAY,EACZ,OAAQ,EACR,UAAW;IAUX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,YAAY,EAAE;QACvC,MAAM,EAAE,wBAAY,CAAC,MAAM;KAC5B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC"}
1
+ {"version":3,"file":"endpoint.js","sourceRoot":"","sources":["../../../../../../src/lib/services/transfer/service/endpoint.ts"],"names":[],"mappings":";;;AAAA,+CAA+D;AAC/D,4CAA0C;AAU1C;;GAEG;AACU,QAAA,GAAG,GAAG,UACjB,YAAY,EACZ,OAAQ,EACR,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,YAAY,EAAE;KACxC,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAIF;;;;;;;;GAQG;AACU,QAAA,MAAM,GAAG,UAAU,OAAQ,EAAE,UAAW;IACnD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE,CAAC;QACrB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,wBAAwB;QAC9B,MAAM,EAAE,wBAAY,CAAC,IAAI;KAC1B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAEE,CAAC;AAIH;;;;;;;GAOG;AACU,QAAA,MAAM,GAAG,UACpB,YAAY,EACZ,OAAQ,EACR,UAAW;IAEX,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE,CAAC;QACrB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,YAAY,EAAE;QACvC,MAAM,EAAE,wBAAY,CAAC,GAAG;KACzB,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC;AAGF;;;;;;;GAOG;AACU,QAAA,MAAM,GAAG,UACpB,YAAY,EACZ,OAAQ,EACR,UAAW;IAEX,OAAO,IAAA,0BAAc,EACnB;QACE,OAAO,EAAE,cAAE;QACX,KAAK,EAAE,kBAAM,CAAC,GAAG;QACjB,IAAI,EAAE,mBAAmB,YAAY,EAAE;QACvC,MAAM,EAAE,wBAAY,CAAC,MAAM;KAC5B,EACD,OAAO,EACP,UAAU,CACX,CAAC;AACJ,CAMC,CAAC"}
@@ -46,7 +46,7 @@ export declare const update: (task_id: string, options?: ({
46
46
  headers?: import("../../../services/types.js").Headers | undefined;
47
47
  }) | undefined, sdkOptions?: import("../../../services/types.js").SDKOptions | undefined) => Promise<JSONFetchResponse<{
48
48
  DATA_TYPE: 'result';
49
- code: 'Udpated';
49
+ code: 'Updated';
50
50
  message: string;
51
51
  request_id: string;
52
52
  resource: `/task/${string}/cancel`;
@@ -1,3 +1,217 @@
1
+ import { ExtractKeys, Segment } from '../types';
2
+ type EntityType = 'GCSv5_endpoint' | 'GCSv5_mapped_collection' | 'GCSv5_guest_collection' | 'GCP_mapped_collection' | 'GCP_guest_collection';
3
+ /**
4
+ * @see https://docs.globus.org/api/transfer/gcp_management/#update_collection_by_id
5
+ */
6
+ type GuestCollectionUpdatableField = ExtractKeys<Components['schemas']['Endpoint'], 'acl_max_expiration_period_mins' | 'display_name' | 'organization' | 'department' | 'keywords' | 'description' | 'contact_email' | 'contact_info' | 'info_link' | 'owner_string' | 'default_directory' | 'force_encryption' | 'disable_verify'>;
7
+ /**
8
+ * @see https://docs.globus.org/api/transfer/gcp_management/#update_collection_by_id
9
+ */
10
+ type MappedCollectionUpdatableField = ExtractKeys<Components['schemas']['Endpoint'], GuestCollectionUpdatableField | 'authentication_timeout_mins' | 'subscription_id' | 'public' | 'location' | 'network_use' | 'max_concurrency' | 'preferred_concurrency' | 'max_parallelism' | 'preferred_parallelism' | 'user_message' | 'user_message_link'>;
11
+ /**
12
+ * @see https://docs.globus.org/api/transfer/endpoint_roles/
13
+ */
14
+ type EndpointRole = 'administrator' | 'access_manager' | 'activity_manager' | 'activity_monitor';
15
+ export interface Components {
16
+ schemas: {
17
+ Endpoint: {
18
+ DATA_TYPE: 'endpoint';
19
+ DATA?: Components['schemas']['Server'][];
20
+ id: string;
21
+ display_name: string;
22
+ organization: string | null;
23
+ department: string | null;
24
+ keywords: string | null;
25
+ /**
26
+ * @deprecated
27
+ */
28
+ name: string | null;
29
+ /**
30
+ * @deprecated use `id` instead in API requests, and use `display_name`
31
+ * to display to users.
32
+ */
33
+ canonical_name: string;
34
+ /**
35
+ * @deprecated use `owner_id` or `owner_string` instead.
36
+ */
37
+ username: string;
38
+ owner_id: string;
39
+ owner_string: string;
40
+ description: string | null;
41
+ contact_email: string | null;
42
+ contact_info: string | null;
43
+ info_link: string | null;
44
+ user_message: string | null;
45
+ user_message_link: string | null;
46
+ public: boolean;
47
+ subscription_id: string | null;
48
+ french_english_bilingual: boolean;
49
+ default_directory: string | null;
50
+ force_encryption: boolean;
51
+ disable_verify: boolean;
52
+ disable_anonymous_writes: boolean;
53
+ entity_type: EntityType;
54
+ force_verify: boolean;
55
+ mfa_required: boolean;
56
+ /**
57
+ * @deprecated GCSv4-specific property - no longer supported
58
+ */
59
+ expire_time: null;
60
+ /**
61
+ * @deprecated GCSv4-specific property - no longer supported
62
+ */
63
+ expires_in: null;
64
+ /**
65
+ * @deprecated GCSv4-specific property - no longer supported
66
+ */
67
+ activated: boolean;
68
+ /**
69
+ * @deprecated GCSv4-specific property - no longer supported
70
+ */
71
+ myproxy_server: string | null;
72
+ /**
73
+ * @deprecated GCSv4-specific property - no longer supported
74
+ */
75
+ myproxy_dn: string | null;
76
+ /**
77
+ * @deprecated GCSv4-specific property - no longer supported
78
+ */
79
+ oauth_server: string | null;
80
+ requester_pays: boolean;
81
+ /**
82
+ * @deprecated - use entity_type intead
83
+ */
84
+ is_globus_connect: boolean;
85
+ gcs_version: string | null;
86
+ globus_connect_setup_key: string | null;
87
+ /**
88
+ * @deprecated use `host_endpoint_id` and `host_endpoint_display_name`
89
+ */
90
+ host_endpoint: string | null;
91
+ /**
92
+ * UUID of standard endpoint hosting the shared endpoint; `null` for non-shared endpoints.
93
+ */
94
+ host_endpoint_id: string | null;
95
+ host_endpoint_display_name: string | null;
96
+ host_path: string | null;
97
+ /**
98
+ * @deprecated
99
+ */
100
+ s3_url: null;
101
+ /**
102
+ * @deprecated
103
+ */
104
+ s3_owner_activated: false;
105
+ /**
106
+ * @deprecated GCSv4-specific property - use entity_type instead
107
+ */
108
+ acl_available: boolean;
109
+ /**
110
+ * @deprecated use `my_effective_roles` instead.
111
+ */
112
+ acl_editable: boolean;
113
+ in_use: boolean;
114
+ my_effective_roles: Array<EndpointRole | 'restricted_administrator'>;
115
+ gcp_connected: boolean | null;
116
+ gcp_paused: boolean | null;
117
+ network_use: 'normal' | 'minimal' | 'aggressive' | 'custom' | null;
118
+ location: string | null;
119
+ max_concurrency: number | null;
120
+ preferred_concurrency: number | null;
121
+ max_parallelism: number | null;
122
+ preferred_parallelism: number | null;
123
+ /**
124
+ * @deprecated GCSv4-specific property - no longer supported
125
+ */
126
+ local_user_info_available: boolean | null;
127
+ https_server: string | null;
128
+ gcs_manager_url: `${string}://${string}` | null;
129
+ tlsftp_server: `tlsftp://${string}:${string}` | null;
130
+ high_assurance: boolean;
131
+ acl_max_expiration_period_mins: number | null;
132
+ authentication_timeout_mins: number | null;
133
+ /**
134
+ * @deprecated use `high_assurance` and `authentication_timeout_mins` instead.
135
+ */
136
+ authentication_assurance_timeout: number;
137
+ non_functional: boolean;
138
+ non_functional_endpoint_id: string | null;
139
+ non_functional_endpoint_display_name: string | null;
140
+ mapped_collection_id: string | null;
141
+ mapped_collection_display_name: string | null;
142
+ last_accessed_time: string | null;
143
+ };
144
+ Server: {
145
+ DATA_TYPE: 'server';
146
+ id: number;
147
+ hostname: null | string;
148
+ port: null | number;
149
+ scheme: null | 'ftp' | 'gsiftp';
150
+ subject: null | string;
151
+ incoming_data_port_start: null | number;
152
+ incoming_data_port_end: null | number;
153
+ outgoing_data_port_start: null | number;
154
+ outgoing_data_port_end: null | number;
155
+ /**
156
+ * @deprecated
157
+ */
158
+ uri: string;
159
+ /**
160
+ * @deprecated
161
+ */
162
+ is_connected: boolean;
163
+ /**
164
+ * @deprecated
165
+ */
166
+ is_paused: boolean;
167
+ };
168
+ };
169
+ }
170
+ export interface Operations extends Record<string, {
171
+ parameters?: Segment;
172
+ response?: any;
173
+ payload?: any;
174
+ }> {
175
+ GetEndpoint: {
176
+ parameters: string;
177
+ response: Components['schemas']['Endpoint'];
178
+ };
179
+ CreateEndpoint: {
180
+ payload: Partial<Pick<Components['schemas']['Endpoint'], GuestCollectionUpdatableField>> & {
181
+ DATA_TYPE?: 'shared_endpoint';
182
+ host_endpoint_id: string;
183
+ host_path: string;
184
+ };
185
+ response: {
186
+ DATA_TYPE: 'endpoint_create_result';
187
+ code: 'Created';
188
+ globus_connect_setup_key: string | null;
189
+ id: string;
190
+ message: string;
191
+ request_id: string;
192
+ resource: '/shared_endpoint';
193
+ };
194
+ };
195
+ UpdateEndpoint: {
196
+ payload: Partial<Pick<Components['schemas']['Endpoint'], MappedCollectionUpdatableField | 'DATA_TYPE'>>;
197
+ response: {
198
+ DATA_TYPE: 'result';
199
+ code: 'Updated';
200
+ message: string;
201
+ request_id: string;
202
+ resource: `/endpoint/${string}`;
203
+ };
204
+ };
205
+ RemoveEndpoint: {
206
+ response: {
207
+ DATA_TYPE: 'result';
208
+ code: 'Deleted';
209
+ message: string;
210
+ request_id: string;
211
+ resource: `/endpoint/${string}`;
212
+ };
213
+ };
214
+ }
1
215
  export interface Transfer {
2
216
  /**
3
217
  * Pagination used by the Transfer service.
@@ -146,4 +360,5 @@ export interface Transfer {
146
360
  };
147
361
  };
148
362
  }
363
+ export {};
149
364
  //# sourceMappingURL=types.d.ts.map