@globus/sdk 5.8.0 → 6.0.0-rc.10
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.
- package/README.md +8 -15
- package/dist/cjs/core/authorization/index.js +142 -18
- package/dist/cjs/core/authorization/index.js.map +3 -3
- package/dist/cjs/index.js +450 -148
- package/dist/cjs/index.js.map +4 -4
- package/dist/cjs/services/globus-connect-server/client.js +2 -2
- package/dist/cjs/services/globus-connect-server/client.js.map +3 -3
- package/dist/esm/apps/web.d.ts +1 -1
- package/dist/esm/apps/web.d.ts.map +1 -1
- package/dist/esm/core/authorization/AuthorizationManager.d.ts +14 -8
- package/dist/esm/core/authorization/AuthorizationManager.d.ts.map +1 -1
- package/dist/esm/core/authorization/AuthorizationManager.js +13 -5
- package/dist/esm/core/authorization/AuthorizationManager.js.map +1 -1
- package/dist/esm/core/authorization/PopupTransport.d.ts +25 -0
- package/dist/esm/core/authorization/PopupTransport.d.ts.map +1 -0
- package/dist/esm/core/authorization/PopupTransport.js +161 -0
- package/dist/esm/core/authorization/PopupTransport.js.map +1 -0
- package/dist/esm/core/authorization/RedirectTransport.d.ts +4 -10
- package/dist/esm/core/authorization/RedirectTransport.d.ts.map +1 -1
- package/dist/esm/core/authorization/RedirectTransport.js +6 -17
- package/dist/esm/core/authorization/RedirectTransport.js.map +1 -1
- package/dist/esm/core/authorization/TokenManager.js +1 -1
- package/dist/esm/core/authorization/TokenManager.js.map +1 -1
- package/dist/esm/core/authorization/pkce.d.ts +15 -0
- package/dist/esm/core/authorization/pkce.d.ts.map +1 -1
- package/dist/esm/core/authorization/pkce.js +18 -0
- package/dist/esm/core/authorization/pkce.js.map +1 -1
- package/dist/esm/core/global.d.ts +1 -1
- package/dist/esm/core/global.d.ts.map +1 -1
- package/dist/esm/core/global.js +3 -3
- package/dist/esm/core/global.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -5
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/open-api/types/compute.d.ts +3759 -0
- package/dist/esm/open-api/types/compute.d.ts.map +1 -0
- package/dist/esm/open-api/types/compute.js +2 -0
- package/dist/esm/open-api/types/compute.js.map +1 -0
- package/dist/esm/open-api/types/flows.d.ts +2540 -0
- package/dist/esm/open-api/types/flows.d.ts.map +1 -0
- package/dist/esm/open-api/types/flows.js +6 -0
- package/dist/esm/open-api/types/flows.js.map +1 -0
- package/dist/esm/open-api/types/gcs/v5.4.d.ts +12052 -0
- package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -0
- package/dist/esm/open-api/types/gcs/v5.4.js +2 -0
- package/dist/esm/open-api/types/gcs/v5.4.js.map +1 -0
- package/dist/esm/open-api/types/groups.d.ts +2382 -0
- package/dist/esm/open-api/types/groups.d.ts.map +1 -0
- package/dist/esm/open-api/types/groups.js +2 -0
- package/dist/esm/open-api/types/groups.js.map +1 -0
- package/dist/esm/open-api/types/search.d.ts +2215 -0
- package/dist/esm/open-api/types/search.d.ts.map +1 -0
- package/dist/esm/open-api/types/search.js +2 -0
- package/dist/esm/open-api/types/search.js.map +1 -0
- package/dist/esm/open-api/types/timer.d.ts +942 -0
- package/dist/esm/open-api/types/timer.d.ts.map +1 -0
- package/dist/esm/open-api/types/timer.js +2 -0
- package/dist/esm/open-api/types/timer.js.map +1 -0
- package/dist/esm/open-api/types/timers.d.ts +942 -0
- package/dist/esm/open-api/types/timers.d.ts.map +1 -0
- package/dist/esm/open-api/types/timers.js +2 -0
- package/dist/esm/open-api/types/timers.js.map +1 -0
- package/dist/esm/package.json +1 -1
- package/dist/esm/services/auth/config.d.ts +1 -1
- package/dist/esm/services/auth/config.js +2 -2
- package/dist/esm/services/auth/config.js.map +1 -1
- package/dist/esm/services/auth/index.d.ts +1 -0
- package/dist/esm/services/auth/index.d.ts.map +1 -1
- package/dist/esm/services/auth/index.js.map +1 -1
- package/dist/esm/services/auth/utils.d.ts +1 -1
- package/dist/esm/services/auth/utils.d.ts.map +1 -1
- package/dist/esm/services/compute/index.d.ts +1 -0
- package/dist/esm/services/compute/index.d.ts.map +1 -1
- package/dist/esm/services/compute/index.js.map +1 -1
- package/dist/esm/services/compute/service/endpoints.d.ts +34 -5
- package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
- package/dist/esm/services/compute/service/endpoints.js +31 -0
- package/dist/esm/services/compute/service/endpoints.js.map +1 -1
- package/dist/esm/services/flows/index.d.ts +1 -0
- package/dist/esm/services/flows/index.d.ts.map +1 -1
- package/dist/esm/services/flows/index.js.map +1 -1
- package/dist/esm/services/flows/service/flows.d.ts +12 -77
- package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
- package/dist/esm/services/flows/service/flows.js.map +1 -1
- package/dist/esm/services/flows/service/runs.d.ts +13 -0
- package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
- package/dist/esm/services/flows/service/runs.js +11 -0
- package/dist/esm/services/flows/service/runs.js.map +1 -1
- package/dist/esm/services/globus-connect-server/client.d.ts +646 -261
- package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/index.d.ts +1 -0
- package/dist/esm/services/globus-connect-server/index.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/index.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/collections.d.ts +40 -40
- package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/collections.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +35 -35
- package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/endpoint.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/nodes.d.ts +30 -30
- package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/nodes.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/roles.d.ts +20 -20
- package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/roles.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +31 -31
- package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/storage-gateways.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts +30 -30
- package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/user-credentials.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/versioning.d.ts +6 -6
- package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/versioning.js.map +1 -1
- package/dist/esm/services/groups/index.d.ts +1 -0
- package/dist/esm/services/groups/index.d.ts.map +1 -1
- package/dist/esm/services/groups/index.js.map +1 -1
- package/dist/esm/services/groups/service/groups.d.ts +5 -5
- package/dist/esm/services/groups/service/groups.d.ts.map +1 -1
- package/dist/esm/services/groups/service/groups.js.map +1 -1
- package/dist/esm/services/groups/service/membership.d.ts +3 -3
- package/dist/esm/services/groups/service/membership.d.ts.map +1 -1
- package/dist/esm/services/groups/service/membership.js.map +1 -1
- package/dist/esm/services/groups/service/policies.d.ts +2 -2
- package/dist/esm/services/groups/service/policies.d.ts.map +1 -1
- package/dist/esm/services/groups/service/policies.js.map +1 -1
- package/dist/esm/services/search/index.d.ts +2 -0
- package/dist/esm/services/search/index.d.ts.map +1 -1
- package/dist/esm/services/search/index.js.map +1 -1
- package/dist/esm/services/shared.d.ts +1 -0
- package/dist/esm/services/shared.d.ts.map +1 -1
- package/dist/esm/services/shared.js.map +1 -1
- package/dist/esm/services/timer/index.d.ts +1 -0
- package/dist/esm/services/timer/index.d.ts.map +1 -1
- package/dist/esm/services/timer/index.js.map +1 -1
- package/dist/esm/services/timer/service/timer.d.ts +28 -2
- package/dist/esm/services/timer/service/timer.d.ts.map +1 -1
- package/dist/esm/services/timer/service/timer.js.map +1 -1
- package/dist/esm/services/timers/config.d.ts +4 -0
- package/dist/esm/services/timers/config.d.ts.map +1 -0
- package/dist/esm/services/timers/config.js +10 -0
- package/dist/esm/services/timers/config.js.map +1 -0
- package/dist/esm/services/timers/index.d.ts +16 -0
- package/dist/esm/services/timers/index.d.ts.map +1 -0
- package/dist/esm/services/timers/index.js +15 -0
- package/dist/esm/services/timers/index.js.map +1 -0
- package/dist/esm/services/timers/service/jobs/index.d.ts +62 -0
- package/dist/esm/services/timers/service/jobs/index.d.ts.map +1 -0
- package/dist/esm/services/timers/service/jobs/index.js +70 -0
- package/dist/esm/services/timers/service/jobs/index.js.map +1 -0
- package/dist/esm/services/timers/service/timer.d.ts +31 -0
- package/dist/esm/services/timers/service/timer.d.ts.map +1 -0
- package/dist/esm/services/timers/service/timer.js +12 -0
- package/dist/esm/services/timers/service/timer.js.map +1 -0
- package/dist/esm/services/transfer/index.d.ts +2 -0
- package/dist/esm/services/transfer/index.d.ts.map +1 -1
- package/dist/esm/services/transfer/index.js +1 -0
- package/dist/esm/services/transfer/index.js.map +1 -1
- package/dist/esm/services/transfer/service/access.d.ts +35 -12
- package/dist/esm/services/transfer/service/access.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/access.js +5 -5
- package/dist/esm/services/transfer/service/access.js.map +1 -1
- package/dist/esm/services/transfer/service/collection-bookmarks.d.ts +20 -6
- package/dist/esm/services/transfer/service/collection-bookmarks.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/collection-bookmarks.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +11 -9
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts +28 -6
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts +100 -22
- package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/task.js +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/task.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-search.d.ts +19 -12
- package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-search.js +2 -11
- package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.d.ts +257 -9
- package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
- package/dist/esm/services/transfer/service/file-operations.d.ts +22 -6
- package/dist/esm/services/transfer/service/file-operations.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/file-operations.js.map +1 -1
- package/dist/esm/services/transfer/service/roles.d.ts +75 -0
- package/dist/esm/services/transfer/service/roles.d.ts.map +1 -0
- package/dist/esm/services/transfer/service/roles.js +49 -0
- package/dist/esm/services/transfer/service/roles.js.map +1 -0
- package/dist/esm/services/transfer/service/task-submission.d.ts +84 -3
- package/dist/esm/services/transfer/service/task-submission.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/task-submission.js.map +1 -1
- package/dist/esm/services/transfer/service/task.d.ts +162 -16
- package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/task.js.map +1 -1
- package/dist/esm/services/transfer/types.d.ts +79 -343
- package/dist/esm/services/transfer/types.d.ts.map +1 -1
- package/dist/umd/globus.production.js +2 -2
- package/dist/umd/globus.production.js.map +4 -4
- package/package.json +10 -17
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import { AuthorizationRequirementsError } from '../../core/errors';
|
|
2
|
-
import { ExtractKeys, Segment } from '../types';
|
|
1
|
+
import { AuthorizationRequirementsError } from '../../core/errors.js';
|
|
3
2
|
/**
|
|
4
3
|
* @see https://docs.globus.org/api/transfer/overview/#errors
|
|
5
4
|
*/
|
|
6
|
-
export type
|
|
5
|
+
export type ErrorDocument = {
|
|
7
6
|
code: string;
|
|
8
7
|
message: string;
|
|
9
8
|
request_id: string;
|
|
@@ -13,366 +12,103 @@ export type TransferErrorDocument = {
|
|
|
13
12
|
*/
|
|
14
13
|
authorization_parameters?: AuthorizationRequirementsError['authorization_parameters'];
|
|
15
14
|
};
|
|
16
|
-
type EntityType = 'GCSv5_endpoint' | 'GCSv5_mapped_collection' | 'GCSv5_guest_collection' | 'GCP_mapped_collection' | 'GCP_guest_collection';
|
|
17
15
|
/**
|
|
18
|
-
* @see https://docs.globus.org/api/transfer/
|
|
16
|
+
* @see https://docs.globus.org/api/transfer/overview/#common_query_parameters
|
|
19
17
|
*/
|
|
20
|
-
type
|
|
18
|
+
export type CommonQueryParameters = {
|
|
19
|
+
orderby?: string;
|
|
20
|
+
fields?: string;
|
|
21
|
+
filter?: string;
|
|
22
|
+
};
|
|
21
23
|
/**
|
|
22
|
-
*
|
|
24
|
+
* Used to define query parameter types for the Transfer service.
|
|
25
|
+
* @private **Intended for internal service method definition only.**
|
|
26
|
+
*
|
|
27
|
+
* @param Parameters The allowed query parameters for the request, `PaginationType` (if no custom parameters are supported), or `undefined` if only the common query parameters are supported.
|
|
28
|
+
* @param PaginationType The type of pagination the request uses, if any.
|
|
29
|
+
* If not specified, no pagination query parameters will be included.
|
|
30
|
+
* @param IncludeCommon Whether to include Transfer common query parameters as allowed query parameters.
|
|
31
|
+
* Defaults to `true`, which includes common query parameters.
|
|
32
|
+
* Set to `false` to exclude common query parameters.
|
|
33
|
+
*
|
|
34
|
+
* @example `QueryParameters<'Marker'>` Supports marker pagination query parameters and common query parameters.
|
|
35
|
+
* @example `QueryParameters<{ endpoint_id: string }, 'Offset'>` Supports a custom query parameter `endpoint_id`, offset pagination, and common query parameters.
|
|
23
36
|
*/
|
|
24
|
-
type
|
|
37
|
+
export type QueryParameters<Parameters extends Record<string, unknown> | keyof Pagination | undefined = Record<string, unknown>, PaginationType extends keyof Pagination | undefined = undefined, IncludeCommon extends boolean = true> = (Parameters extends keyof Pagination ? Pagination[Parameters] extends {
|
|
38
|
+
Query: infer Q;
|
|
39
|
+
} ? Q : {} : Parameters extends Record<string, unknown> ? Parameters : {}) & (PaginationType extends keyof Pagination ? Pagination[PaginationType]['Query'] : {}) & (IncludeCommon extends true ? CommonQueryParameters : {});
|
|
25
40
|
/**
|
|
26
|
-
*
|
|
41
|
+
* Add pagination response members to an object; Use for creating paginated responses in the Transfer service.
|
|
42
|
+
* @private **Intended for internal service method definition only.**
|
|
43
|
+
* @param PaginationType The type of pagination the response uses.
|
|
44
|
+
* @param Response The response to extend with the pagination response.
|
|
45
|
+
* @example `PaginatedResponse<'Offset', { DATA_TYPE: 'task_list'; tasks: TaskDocument[] }>`
|
|
27
46
|
*/
|
|
28
|
-
type
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
*/
|
|
51
|
-
username: string;
|
|
52
|
-
owner_id: string;
|
|
53
|
-
owner_string: string;
|
|
54
|
-
description: string | null;
|
|
55
|
-
contact_email: string | null;
|
|
56
|
-
contact_info: string | null;
|
|
57
|
-
info_link: string | null;
|
|
58
|
-
user_message: string | null;
|
|
59
|
-
user_message_link: string | null;
|
|
60
|
-
public: boolean;
|
|
61
|
-
subscription_id: string | null;
|
|
62
|
-
french_english_bilingual: boolean;
|
|
63
|
-
default_directory: string | null;
|
|
64
|
-
force_encryption: boolean;
|
|
65
|
-
disable_verify: boolean;
|
|
66
|
-
disable_anonymous_writes: boolean;
|
|
67
|
-
entity_type: EntityType;
|
|
68
|
-
force_verify: boolean;
|
|
69
|
-
mfa_required: boolean;
|
|
70
|
-
/**
|
|
71
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
72
|
-
*/
|
|
73
|
-
expire_time: null;
|
|
74
|
-
/**
|
|
75
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
76
|
-
*/
|
|
77
|
-
expires_in: null;
|
|
78
|
-
/**
|
|
79
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
80
|
-
*/
|
|
81
|
-
activated: boolean;
|
|
82
|
-
/**
|
|
83
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
84
|
-
*/
|
|
85
|
-
myproxy_server: string | null;
|
|
86
|
-
/**
|
|
87
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
88
|
-
*/
|
|
89
|
-
myproxy_dn: string | null;
|
|
90
|
-
/**
|
|
91
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
92
|
-
*/
|
|
93
|
-
oauth_server: string | null;
|
|
94
|
-
requester_pays: boolean;
|
|
95
|
-
/**
|
|
96
|
-
* @deprecated - use entity_type intead
|
|
97
|
-
*/
|
|
98
|
-
is_globus_connect: boolean;
|
|
99
|
-
gcs_version: string | null;
|
|
100
|
-
globus_connect_setup_key: string | null;
|
|
101
|
-
/**
|
|
102
|
-
* @deprecated use `host_endpoint_id` and `host_endpoint_display_name`
|
|
103
|
-
*/
|
|
104
|
-
host_endpoint: string | null;
|
|
105
|
-
/**
|
|
106
|
-
* UUID of standard endpoint hosting the shared endpoint; `null` for non-shared endpoints.
|
|
107
|
-
*/
|
|
108
|
-
host_endpoint_id: string | null;
|
|
109
|
-
host_endpoint_display_name: string | null;
|
|
110
|
-
host_path: string | null;
|
|
111
|
-
/**
|
|
112
|
-
* @deprecated
|
|
113
|
-
*/
|
|
114
|
-
s3_url: null;
|
|
115
|
-
/**
|
|
116
|
-
* @deprecated
|
|
117
|
-
*/
|
|
118
|
-
s3_owner_activated: false;
|
|
119
|
-
/**
|
|
120
|
-
* @deprecated GCSv4-specific property - use entity_type instead
|
|
121
|
-
*/
|
|
122
|
-
acl_available: boolean;
|
|
123
|
-
/**
|
|
124
|
-
* @deprecated use `my_effective_roles` instead.
|
|
125
|
-
*/
|
|
126
|
-
acl_editable: boolean;
|
|
127
|
-
in_use: boolean;
|
|
128
|
-
my_effective_roles: Array<EndpointRole | 'restricted_administrator'>;
|
|
129
|
-
gcp_connected: boolean | null;
|
|
130
|
-
gcp_paused: boolean | null;
|
|
131
|
-
network_use: 'normal' | 'minimal' | 'aggressive' | 'custom' | null;
|
|
132
|
-
location: string | null;
|
|
133
|
-
max_concurrency: number | null;
|
|
134
|
-
preferred_concurrency: number | null;
|
|
135
|
-
max_parallelism: number | null;
|
|
136
|
-
preferred_parallelism: number | null;
|
|
137
|
-
/**
|
|
138
|
-
* @deprecated GCSv4-specific property - no longer supported
|
|
139
|
-
*/
|
|
140
|
-
local_user_info_available: boolean | null;
|
|
141
|
-
https_server: string | null;
|
|
142
|
-
gcs_manager_url: `${string}://${string}` | null;
|
|
143
|
-
tlsftp_server: `tlsftp://${string}:${string}` | null;
|
|
144
|
-
high_assurance: boolean;
|
|
145
|
-
acl_max_expiration_period_mins: number | null;
|
|
146
|
-
authentication_timeout_mins: number | null;
|
|
147
|
-
/**
|
|
148
|
-
* @deprecated use `high_assurance` and `authentication_timeout_mins` instead.
|
|
149
|
-
*/
|
|
150
|
-
authentication_assurance_timeout: number;
|
|
151
|
-
non_functional: boolean;
|
|
152
|
-
non_functional_endpoint_id: string | null;
|
|
153
|
-
non_functional_endpoint_display_name: string | null;
|
|
154
|
-
mapped_collection_id: string | null;
|
|
155
|
-
mapped_collection_display_name: string | null;
|
|
156
|
-
last_accessed_time: string | null;
|
|
157
|
-
};
|
|
158
|
-
Server: {
|
|
159
|
-
DATA_TYPE: 'server';
|
|
160
|
-
id: number;
|
|
161
|
-
hostname: null | string;
|
|
162
|
-
port: null | number;
|
|
163
|
-
scheme: null | 'ftp' | 'gsiftp';
|
|
164
|
-
subject: null | string;
|
|
165
|
-
incoming_data_port_start: null | number;
|
|
166
|
-
incoming_data_port_end: null | number;
|
|
167
|
-
outgoing_data_port_start: null | number;
|
|
168
|
-
outgoing_data_port_end: null | number;
|
|
169
|
-
/**
|
|
170
|
-
* @deprecated
|
|
171
|
-
*/
|
|
172
|
-
uri: string;
|
|
173
|
-
/**
|
|
174
|
-
* @deprecated
|
|
175
|
-
*/
|
|
176
|
-
is_connected: boolean;
|
|
177
|
-
/**
|
|
178
|
-
* @deprecated
|
|
179
|
-
*/
|
|
180
|
-
is_paused: boolean;
|
|
181
|
-
};
|
|
182
|
-
};
|
|
183
|
-
}
|
|
184
|
-
export interface Operations extends Record<string, {
|
|
185
|
-
parameters?: Segment;
|
|
186
|
-
response?: any;
|
|
187
|
-
payload?: any;
|
|
188
|
-
}> {
|
|
189
|
-
GetEndpoint: {
|
|
190
|
-
parameters: string;
|
|
191
|
-
response: Components['schemas']['Endpoint'];
|
|
192
|
-
};
|
|
193
|
-
CreateEndpoint: {
|
|
194
|
-
payload: Partial<Pick<Components['schemas']['Endpoint'], GuestCollectionUpdatableField>> & {
|
|
195
|
-
DATA_TYPE?: 'shared_endpoint';
|
|
196
|
-
host_endpoint_id: string;
|
|
197
|
-
host_path: string;
|
|
47
|
+
export type PaginatedResponse<Type, Response> = Response & (Type extends keyof Pagination ? Pagination[Type]['Response'] : {});
|
|
48
|
+
/**
|
|
49
|
+
* Pagination used by the Transfer service.
|
|
50
|
+
*
|
|
51
|
+
* Each pagination definition contains a `Query` and `Response` type.
|
|
52
|
+
* - The `Query` type is used to define the query parameters used by the pagination method.
|
|
53
|
+
* - The `Response` type is used to define the response properties returned by the pagination method (usually as
|
|
54
|
+
* top-level keys in the response body).
|
|
55
|
+
*
|
|
56
|
+
* Service methods **SHOULD** include the supported pagination members in their query parameters and response types, these
|
|
57
|
+
* are just made available as a convenience.
|
|
58
|
+
*
|
|
59
|
+
* @see https://docs.globus.org/api/transfer/overview/#paging
|
|
60
|
+
*/
|
|
61
|
+
export type Pagination = {
|
|
62
|
+
/**
|
|
63
|
+
* @see https://docs.globus.org/api/transfer/overview/#offset_paging
|
|
64
|
+
*/
|
|
65
|
+
Offset: {
|
|
66
|
+
Query: {
|
|
67
|
+
limit?: `${number}` | number;
|
|
68
|
+
offset?: `${number}` | number;
|
|
198
69
|
};
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
id: string;
|
|
204
|
-
message: string;
|
|
205
|
-
request_id: string;
|
|
206
|
-
resource: '/shared_endpoint';
|
|
70
|
+
Response: {
|
|
71
|
+
limit: number;
|
|
72
|
+
offset: number;
|
|
73
|
+
has_next_page: `${boolean}` | boolean;
|
|
207
74
|
};
|
|
208
75
|
};
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
request_id: string;
|
|
216
|
-
resource: `/endpoint/${string}`;
|
|
76
|
+
/**
|
|
77
|
+
* @see https://docs.globus.org/api/transfer/overview/#marker_paging
|
|
78
|
+
*/
|
|
79
|
+
Marker: {
|
|
80
|
+
Query: {
|
|
81
|
+
marker?: `${number}` | number;
|
|
217
82
|
};
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
response: {
|
|
221
|
-
DATA_TYPE: 'result';
|
|
222
|
-
code: 'Deleted';
|
|
223
|
-
message: string;
|
|
224
|
-
request_id: string;
|
|
225
|
-
resource: `/endpoint/${string}`;
|
|
83
|
+
Response: {
|
|
84
|
+
next_marker: number | null;
|
|
226
85
|
};
|
|
227
86
|
};
|
|
228
|
-
}
|
|
229
|
-
export interface Transfer {
|
|
230
87
|
/**
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
* Each pagination definition contains a `Query` and `Response` type.
|
|
234
|
-
* - The `Query` type is used to define the query parameters used by the pagination method.
|
|
235
|
-
* - The `Response` type is used to define the response properties returned by the pagination method (usually as
|
|
236
|
-
* top-level keys in the response body).
|
|
237
|
-
*
|
|
238
|
-
* @see https://docs.globus.org/api/transfer/overview/#paging
|
|
88
|
+
* @see https://docs.globus.org/api/transfer/overview/#last_key_paging
|
|
239
89
|
*/
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
Offset: {
|
|
245
|
-
Query: {
|
|
246
|
-
limit?: `${number}` | number;
|
|
247
|
-
offset?: `${number}` | number;
|
|
248
|
-
};
|
|
249
|
-
Response: {
|
|
250
|
-
limit: number;
|
|
251
|
-
offset: number;
|
|
252
|
-
has_next_page: `${boolean}` | boolean;
|
|
253
|
-
};
|
|
254
|
-
};
|
|
255
|
-
/**
|
|
256
|
-
* @see https://docs.globus.org/api/transfer/overview/#marker_paging
|
|
257
|
-
*/
|
|
258
|
-
Marker: {
|
|
259
|
-
Query: {
|
|
260
|
-
marker?: `${number}` | number;
|
|
261
|
-
};
|
|
262
|
-
Response: {
|
|
263
|
-
next_marker: number | null;
|
|
264
|
-
};
|
|
90
|
+
LastKey: {
|
|
91
|
+
Query: {
|
|
92
|
+
limit?: `${number}` | number;
|
|
93
|
+
last_key: string;
|
|
265
94
|
};
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
Query: {
|
|
271
|
-
limit?: `${number}` | number;
|
|
272
|
-
last_key: string;
|
|
273
|
-
};
|
|
274
|
-
Response: {
|
|
275
|
-
has_next_page: `${boolean}` | boolean;
|
|
276
|
-
last_key: string | null;
|
|
277
|
-
limit: number;
|
|
278
|
-
};
|
|
279
|
-
};
|
|
280
|
-
/**
|
|
281
|
-
* @see https://docs.globus.org/api/transfer/overview/#next_token_paging
|
|
282
|
-
*/
|
|
283
|
-
NextToken: {
|
|
284
|
-
Query: {
|
|
285
|
-
next_token?: string;
|
|
286
|
-
max_results?: `${number}` | number;
|
|
287
|
-
};
|
|
288
|
-
Response: {
|
|
289
|
-
next_token: string | null;
|
|
290
|
-
};
|
|
95
|
+
Response: {
|
|
96
|
+
has_next_page: `${boolean}` | boolean;
|
|
97
|
+
last_key: string | null;
|
|
98
|
+
limit: number;
|
|
291
99
|
};
|
|
292
100
|
};
|
|
293
101
|
/**
|
|
294
|
-
* @see https://docs.globus.org/api/transfer/
|
|
102
|
+
* @see https://docs.globus.org/api/transfer/overview/#next_token_paging
|
|
295
103
|
*/
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
offset?: `${number}` | number;
|
|
301
|
-
orderby?: string;
|
|
302
|
-
filter?: string;
|
|
303
|
-
};
|
|
304
|
-
Request: {
|
|
305
|
-
/**
|
|
306
|
-
* Common fields for Transfer and Delete requests.
|
|
307
|
-
* @see https://docs.globus.org/api/transfer/task_submit/#common_transfer_and_delete_fields
|
|
308
|
-
*/
|
|
309
|
-
Common: {
|
|
310
|
-
submission_id: string;
|
|
311
|
-
label?: string;
|
|
312
|
-
notify_on_succeeded?: boolean;
|
|
313
|
-
notify_on_failed?: boolean;
|
|
314
|
-
deadline?: string;
|
|
315
|
-
store_base_path_info?: boolean;
|
|
104
|
+
NextToken: {
|
|
105
|
+
Query: {
|
|
106
|
+
next_token?: string;
|
|
107
|
+
max_results?: `${number}` | number;
|
|
316
108
|
};
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
path: string;
|
|
320
|
-
};
|
|
321
|
-
Rename: {
|
|
322
|
-
DATA_TYPE: 'rename';
|
|
323
|
-
old_path: string;
|
|
324
|
-
new_path: string;
|
|
325
|
-
};
|
|
326
|
-
Symlink: {
|
|
327
|
-
DATA_TYPE: 'symlink';
|
|
328
|
-
path: string;
|
|
329
|
-
symlink_target: string;
|
|
330
|
-
};
|
|
331
|
-
Delete: Transfer['Request']['Common'] & {
|
|
332
|
-
DATA_TYPE: 'delete';
|
|
333
|
-
DATA: {
|
|
334
|
-
DATA_TYPE: string;
|
|
335
|
-
path: string;
|
|
336
|
-
}[];
|
|
337
|
-
endpoint: string;
|
|
338
|
-
ignore_missing?: boolean;
|
|
339
|
-
recursive?: boolean;
|
|
340
|
-
interpret_globs?: boolean;
|
|
341
|
-
local_user?: string;
|
|
342
|
-
};
|
|
343
|
-
Transfer: Transfer['Request']['Common'] & {
|
|
344
|
-
DATA_TYPE: 'transfer';
|
|
345
|
-
DATA: {
|
|
346
|
-
DATA_TYPE: string;
|
|
347
|
-
source_path: string;
|
|
348
|
-
destination_path: string;
|
|
349
|
-
recursive?: boolean;
|
|
350
|
-
external_checksum?: string;
|
|
351
|
-
checksum_algorithm?: string;
|
|
352
|
-
}[];
|
|
353
|
-
source_endpoint: string;
|
|
354
|
-
destination_endpoint: string;
|
|
355
|
-
filter_rules?: {
|
|
356
|
-
DATA_TYPE: 'filter_rule';
|
|
357
|
-
method: 'include' | 'exclude';
|
|
358
|
-
type?: 'file' | 'dir';
|
|
359
|
-
name: string;
|
|
360
|
-
}[];
|
|
361
|
-
encrypt_data?: boolean;
|
|
362
|
-
sync_level?: 0 | 1 | 2 | 3;
|
|
363
|
-
verify_checksum?: boolean;
|
|
364
|
-
preserve_timestamp?: boolean;
|
|
365
|
-
delete_destination_extra?: boolean;
|
|
366
|
-
/**
|
|
367
|
-
* @beta
|
|
368
|
-
*/
|
|
369
|
-
recursive_symlinks?: 'ignore' | 'keep' | 'copy';
|
|
370
|
-
skip_source_errors?: boolean;
|
|
371
|
-
fail_on_quota_errors?: boolean;
|
|
372
|
-
source_local_user?: string;
|
|
373
|
-
destination_local_user?: string;
|
|
109
|
+
Response: {
|
|
110
|
+
next_token: string | null;
|
|
374
111
|
};
|
|
375
112
|
};
|
|
376
|
-
}
|
|
377
|
-
export {};
|
|
113
|
+
};
|
|
378
114
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/services/transfer/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/services/transfer/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,wBAAwB,CAAC,EAAE,8BAA8B,CAAC,0BAA0B,CAAC,CAAC;CACvF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,CACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,UAAU,GAAG,SAAS,GAAG,MAAM,CAChF,MAAM,EACN,OAAO,CACR,EACD,cAAc,SAAS,MAAM,UAAU,GAAG,SAAS,GAAG,SAAS,EAC/D,aAAa,SAAS,OAAO,GAAG,IAAI,IAClC,CAAC,UAAU,SAAS,MAAM,UAAU,GACpC,UAAU,CAAC,UAAU,CAAC,SAAS;IAAE,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAC/C,CAAC,GACD,EAAE,GACJ,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,UAAU,GACV,EAAE,CAAC,GACP,CAAC,cAAc,SAAS,MAAM,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GACpF,CAAC,aAAa,SAAS,IAAI,GAAG,qBAAqB,GAAG,EAAE,CAAC,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,CAAC,IAAI,EAAE,QAAQ,IAAI,QAAQ,GACtD,CAAC,IAAI,SAAS,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;YAC7B,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;SAC/B,CAAC;QACF,QAAQ,EAAE;YACR,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;YACf,aAAa,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC;SACvC,CAAC;KACH,CAAC;IACF;;OAEG;IACH,MAAM,EAAE;QACN,KAAK,EAAE;YACL,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;SAC/B,CAAC;QACF,QAAQ,EAAE;YACR,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B,CAAC;KACH,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACP,KAAK,EAAE;YACL,KAAK,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;YAC7B,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,QAAQ,EAAE;YACR,aAAa,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC;YACtC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF;;OAEG;IACH,SAAS,EAAE;QACT,KAAK,EAAE;YACL,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;SACpC,CAAC;QACF,QAAQ,EAAE;YACR,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B,CAAC;KACH,CAAC;CACH,CAAC"}
|