@globus/sdk 0.1.4-alpha.0 → 0.1.6-alpha.0

package/@types/globus/transfer/index.d.ts

@@ -0,0 +1,729 @@
+namespace Globus.Transfer {
+  /**
+   * @see https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
+   */
+  export type DirectoryListingQuery = {
+    path?: string;
+    show_hidden?: "true" | "false";
+    limit?: `${number}`;
+    offset?: `${number}`;
+    orderby?: string;
+    filter?: string;
+  };
+}
+
+declare namespace Globus.Transfer.Request {
+  export interface Mkdir {
+    path: string;
+  }
+  export interface Rename {
+    DATA_TYPE: "mkdir";
+    old_path: string;
+    new_path: string;
+  }
+  export interface Symlink {
+    DATA_TYPE: "symlink";
+    path: string;
+    symlink_target: string;
+  }
+
+  export interface Delete {
+    DATA_TYPE: "delete";
+    endpoint: string;
+    submission_id: string;
+    DATA: { DATA_TYPE: string; path: string }[];
+    ignore_missing?: boolean;
+    recursive?: boolean;
+  }
+
+  export interface Transfer {
+    DATA_TYPE: "transfer";
+  }
+}
+
+// Type definitions for Globus Transfer
+declare namespace Globus.Transfer {
+  export enum DATA_TYPE {
+    access = "access",
+    bookmark = "bookmark",
+    endpoint = "endpoint",
+    event = "event",
+    file = "file",
+    filter_rule = "filter_rule",
+    pause_rule_limited = "pause_rule_limited",
+    pause_info_limited = "pause_info_limited",
+    server = "server",
+    skipped_error = "skipped_error",
+    successful_transfer = "successful_transfer",
+    skipped_errors = "skipped_errors",
+    successful_transfers = "successful_transfers",
+    role = "role",
+    task = "task",
+    access_list = "access_list",
+    bookmark_list = "bookmark_list",
+    endpoint_list = "endpoint_list",
+    event_list = "event_list",
+    file_list = "file_list",
+    role_list = "role_list",
+    server_list = "server_list",
+    task_list = "task_list",
+    transfer_item = "transfer_item",
+    transfer_request = "transfer_request",
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/overview/#errors
+   */
+  export interface APIErrorResponse {
+    code: string;
+    message: string;
+    request_id: string;
+    resource: string;
+  }
+
+  export interface AuthorizationParametersError extends APIErrorResponse {
+    /**
+     * A Transfer response that includes `authorization_parameters`
+     * will have slightly different value formats than the Globus Auth response.
+     */
+    authorization_parameters: Omit<
+      Globus.Auth.AuthorizationParameters,
+      "session_required_single_domain" | "session_required_policies"
+    > & {
+      session_required_single_domain?: string[];
+      /**
+       * Transfer returns this value as a comma-separated string.
+       */
+      session_required_policies?: string;
+    };
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/overview/#document_formats
+   */
+  export interface TransferEntity {
+    DATA_TYPE: keyof typeof DATA_TYPE;
+    DATA?: TransferEntity[];
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint_roles/
+   */
+  export enum EndpointRole {
+    administrator = "administrator",
+    access_manager = "access_manager",
+    activity_manager = "activity_manager",
+    activity_monitor = "activity_monitor",
+  }
+
+  export enum EntityType {
+    GCSv4_host = "GCSv4_host",
+    GCSv4_share = "GCSv4_share",
+    GCSv5_endpoint = "GCSv5_endpoint",
+    GCSv5_mapped_collection = "GCSv5_mapped_collection",
+    GCSv5_guest_collection = "GCSv5_guest_collection",
+    GCP_mapped_collection = "GCP_mapped_collection",
+    GCP_guest_collection = "GCP_guest_collection",
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/acl/#access_document
+   */
+  interface AccessDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.access}`;
+    id: null | Globus.UUID;
+    role_id: null | Globus.UUID;
+    role_type:
+      | null
+      | `${EndpointRole.administrator}`
+      | `${EndpointRole.access_manager}`;
+    principal_type:
+      | "identity"
+      | "group"
+      | "all_authenticated_users"
+      | "anonymous";
+    principal: "" | Globus.UUID;
+    path: string;
+    permissions: "r" | "rw";
+    create_time: null | string;
+    notify_email?: null | string;
+    notify_message?: null | string;
+  }
+
+  interface AccessListDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.access_list}`;
+    DATA: AccessDocument[];
+    length: number;
+    endpoint: string;
+  }
+
+  type BookmarkDocument = {
+    DATA_TYPE: `${DATA_TYPE.bookmark}`;
+    id: string;
+    name: string;
+    endpoint_id: string;
+    path: string;
+  };
+
+  type BookmarkListDocument = {
+    DATA_TYPE: `${DATA_TYPE.bookmark_list}`;
+    DATA: Array<BookmarkDocument>;
+  };
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint_roles/#role_document_fields
+   */
+  export interface RoleDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.role}`;
+    id: Globus.UUID;
+    principal_type: "identity" | "group";
+    principal: string;
+    role: `${EndpointRole}`;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint_roles/#role_list
+   */
+  export interface RoleListDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.role_list}`;
+    DATA: RoleDocument[];
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint/#server_fields
+   */
+  export interface ServerDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.server}`;
+    id: number;
+    hostname: string;
+    port: number;
+    scheme: string;
+    subject: string;
+    incoming_data_port_start: number;
+    incoming_data_port_end: number;
+    outgoing_data_port_start: number;
+    outgoing_data_port_end: number;
+    /**
+     * @deprecated
+     */
+    uri: string;
+    /**
+     * @deprecated
+     */
+    is_connected: boolean;
+    /**
+     * @deprecated
+     */
+    is_paused: boolean;
+  }
+
+  export enum TaskType {
+    TRANSFER = "TRANSFER",
+    DELETE = "DELETE",
+  }
+
+  export enum TaskStatus {
+    /**
+     * The task is in progress.
+     */
+    ACTIVE = "ACTIVE",
+    /**
+     * The task has been suspended and will not continue without intervention.
+     * Currently, only credential expiration will cause this state.
+     */
+    INACTIVE = "INACTIVE",
+    /**
+     * The task completed successfully.
+     */
+    SUCCEEDED = "SUCCEEDED",
+    /**
+     * The task or one of its subtasks failed, expired, or was canceled.
+     */
+    FAILED = "FAILED",
+  }
+
+  export const enum CanceledByAdmin {
+    SOURCE = "SOURCE",
+    DESTINATION = "DESTINATION",
+    BOTH = "BOTH",
+  }
+
+  export const enum LocalUserStatus {
+    OK = "OK",
+    NO_PERMISSION = "NO_PERMISSION",
+    NOT_SCANNED = "NOT_SCANNED",
+    ENDPOINT_ERROR = "ENDPOINT_ERROR",
+  }
+
+  /**
+   * The "task" document type represents a single transfer or delete submission.
+   *
+   * @see https://docs.globus.org/api/transfer/task/#task_document
+   */
+  export interface TaskDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.task}`;
+    task_id: string;
+    type: TaskType;
+    status: TaskStatus;
+    fatal_error: object | null;
+    label: string | null;
+    /**
+     * @deprecated use `owner_id` instead.
+     */
+    username: string;
+    owner_id: string;
+    request_time: string;
+    completion_time: string | null;
+    deadline: string | null;
+    /**
+     * @deprecated use `source_endpoint_id`
+     */
+    source_endpoint: string;
+    source_endpoint_id: string;
+    source_endpoint_display_name: string;
+    /**
+     * @deprecated use `destination_endpoint_id`
+     */
+    destination_endpoint: string;
+    destination_endpoint_id: string | null;
+    destination_endpoint_display_name: string;
+    sync_level: number | null;
+    encrypt_data: boolean;
+    verify_checksum: boolean;
+    delete_destination_extra: boolean;
+    recursive_symlinks: string | null;
+    preserve_timestamp: boolean;
+    skip_source_errors: boolean;
+    fail_on_quota_errors: boolean;
+    command: string;
+    history_deleted: boolean;
+    faults: number;
+    files: number;
+    directories: number;
+    symlinks: number;
+    files_skipped: number;
+    files_transferred: number;
+    subtasks_total: number;
+    subtasks_pending: number;
+    subtasks_retrying: number;
+    subtasks_succeeded: number;
+    subtasks_expired: number;
+    subtasks_canceled: number;
+    subtasks_failed: number;
+    subtasks_skipped_errors: number;
+    bytes_transferred: number;
+    bytes_checksummed: number;
+    effective_bytes_per_second: number;
+    nice_status: string | null;
+    /**
+     * @deprecated use `event_list`
+     */
+    nice_status_details: null;
+    nice_status_short_description: string | null;
+    nice_status_expires_in: -1 | 0 | string | null;
+    canceled_by_admin: CanceledByAdmin | null;
+    canceled_by_admin_message: string | null;
+    is_paused: boolean;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task/#filter_and_order_by_options
+   */
+  export interface TaskQuery extends BaseTransferQuery {
+    task_id?: string;
+    type?: string;
+    status?: string;
+    label?: string;
+    request_time?: string;
+    completion_time?: string;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task_submit/#filter_rules
+   */
+  export interface FilterRuleDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.filter_rule}`;
+    method: "exclude";
+    type?: "file" | "dir" | null | undefined;
+    name: string;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task/#event_fields
+   */
+  export interface TaskEventDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.event}`;
+    code: string;
+    is_error: boolean;
+    description: string;
+    details: string;
+    time: string;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task/#get_event_list
+   */
+  export interface TaskEventListDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.event_list}`;
+    DATA: Array<TaskEventDocument>;
+    length: number;
+    limit: number;
+    offset: number;
+    total: number;
+  }
+
+  /**
+   * Note that source_path or destination_path here will be null when the user does not have
+   * role permissions for one side of the transfer
+   *
+   * @see https://docs.globus.org/api/transfer/task/#skipped_error_fields
+   */
+  export interface SkippedErrorsDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.skipped_error}`;
+    error_code: "PERMISSION_DENIED" | "FILE_NOT_FOUND";
+    error_details: string;
+    source_path: string | null;
+    destination_path: string | null;
+    is_directory: boolean;
+    is_symlink: boolean;
+    is_delete_destination_extra: boolean;
+    external_checksum: string;
+    checksum_algorithm: string;
+  }
+
+  /**
+   * Note that source_path or destination_path here will be null when the user does not have
+   * role permissions for one side of the transfer
+   *
+   * @see https://docs.globus.org/api/transfer/task/#get_task_successful_transfers
+   */
+  export interface SuccessfulTransfersDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.successful_transfer}`;
+    source_path: string | null;
+    destination_path: string | null;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task/#get_task_skipped_errors
+   */
+  export interface SkippedErrorsListDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.skipped_errors}`;
+    marker: number;
+    next_marker: null | number;
+    DATA: Array<SkippedErrorsDocument>;
+  }
+
+  export interface SuccessfulTransfersListDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.successful_transfers}`;
+    marker: number;
+    next_marker: null | number;
+    DATA: Array<SuccessfulTransfersDocument>;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task/#limited_pause_rule_document
+   */
+  export type PauseRuleLimitedDocument = Omit<
+    Globus.Transfer.PauseRuleDocument,
+    | "modified_by"
+    | "modified_by_id"
+    | "created_by_host_manager"
+    | "editable"
+    | "DATA_TYPE"
+  > & {
+    DATA_TYPE: `${DATA_TYPE.pause_rule_limited}`;
+  };
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task/#get_task_pause_info
+   */
+  export interface PauseInfoLimitedDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.pause_info_limited}`;
+    pause_rules: Array<PauseRuleLimitedDocument>;
+    source_pause_message: string | null;
+    destination_pause_message: string | null;
+    source_pause_message_share: string | null;
+    destination_pause_message_share: string | null;
+  }
+
+  // enum EndpointExpiresIn {
+  //   NEVER = -1,
+  //   EXPIRED = 0,
+  //   NOT_ACTIVATED = 0,
+  //   SECONDS = number
+  // }
+  type EndpointExpiresIn = -1 | 0 | number;
+
+  // enum EndpointExpiresTime {
+  //   NOT_ACTIVATED = null,
+  //   TIME = string
+  // }
+  type EndpointExpiresTime = null | string;
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint/#endpoint_document
+   */
+  export interface EndpointDocument extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.endpoint}`;
+    DATA?: ServerDocument[];
+    id: string;
+    display_name: string;
+    organization: string;
+    department: string;
+    keywords: string;
+    /**
+     * @deprecated
+     */
+    name: string;
+    /**
+     * @deprecated use `id` instead in API requests, and use `display_name`
+     *             to display to users.
+     */
+    canonical_name: string;
+    /**
+     * @deprecated use `owner_id` or `owner_string` instead.
+     */
+    username: string;
+    owner_id: string;
+    owner_string: string;
+    description: string;
+    contact_email?: string;
+    contact_info?: string;
+    info_link: string;
+    user_message: string;
+    user_message_link: string;
+    public: boolean;
+    subscription_id: string;
+    french_english_bilingual: boolean;
+    default_directory: string;
+    force_encryption: boolean;
+    disable_verify: boolean;
+    disable_anonymous_writes: boolean;
+    entity_type: `${EntityType}`;
+    force_verify: boolean;
+    mfa_required: boolean;
+    expire_time: EndpointExpiresTime;
+    expires_in: EndpointExpiresIn;
+    activated: boolean;
+    myproxy_server: string | null;
+    myproxy_dn: string | null;
+    oauth_server: string;
+    requester_pays: boolean;
+    /**
+     * `true` if the endpoint was created for Globus Connect Personal, `false` otherwise.
+     */
+    is_globus_connect: boolean;
+    gcs_version: string;
+    globus_connect_setup_key: string | null;
+    /**
+     * @deprecated use `host_endpoint_id` and `host_endpoint_display_name`
+     */
+    host_endpoint: string | null;
+    /**
+     * UUID of standard endpoint hosting the shared endpoint; `null` for non-shared endpoints.
+     */
+    host_endpoint_id: string | null;
+    host_endpoint_display_name: string | null;
+    /**
+     * @deprecated
+     */
+    host_path: string | null;
+    /**
+     * @deprecated
+     */
+    s3_url: null;
+    /**
+     * @deprecated
+     */
+    s3_owner_activated: false;
+    acl_available: boolean;
+    /**
+     * @deprecated use `my_effective_roles` instead.
+     */
+    acl_editable: boolean;
+    in_use: boolean;
+    my_effective_roles: Array<`${EndpointRole}` | "restricted_administrator">;
+    gcp_connected: boolean | null;
+    gcp_paused: boolean | null;
+    network_use: null | "normal" | "minimal" | "aggressive" | "custom";
+    location: string | null;
+    max_concurrency: null | number;
+    preferred_concurrency: null | number;
+    max_parallelism: null | number;
+    preferred_parallelism: null | number;
+    local_user_info_available: null | boolean;
+    https_server: null | string;
+    gcs_manager_url: null | `${string}://${string}`;
+    high_assurance: boolean;
+    authentication_timeout_mins: number;
+    /**
+     * @deprecated use `high_assurance` and `authentication_timeout_mins` instead.
+     */
+    authentication_assurance_timeout: number;
+    non_functional: boolean;
+    non_functional_endpoint_id: string | null;
+    non_functional_endpoint_display_name: string | null;
+    mapped_collection_id: string | null;
+    mapped_collection_display_name: string | null;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/overview/#common_query_parameters
+   */
+  interface BaseTransferQuery {
+    limit?: number;
+    offset?: number;
+    orderby?: string;
+    fields?: string;
+    /** @deprecated */
+    filter?: string;
+  }
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint_search/#search_scope
+   */
+  export type EndpointSearchScope =
+    | "all"
+    | "my-endpoints"
+    | "my-gcp-endpoints"
+    | "recently-used"
+    | "in-use"
+    | "shared-by-me"
+    | "shared-with-me"
+    | "administered-by-me";
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint_search/#endpoint_search
+   */
+  export interface EndpointSearchQuery extends BaseTransferQuery {
+    limit: number;
+    filter_scope?: EndpointSearchScope;
+    filter_fulltext?: string;
+    filter_owner_id?: string;
+    filter_host_endpoint?: string;
+    filter_non_functional?: 0 | 1 | null;
+    offset?: number;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/endpoint_search/
+   */
+  export interface EndpointSearchResults extends TransferEntity {
+    DATA_TYPE: `${DATA_TYPE.endpoint_list}`;
+    offset: number;
+    limit: number;
+    has_next_page: boolean;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task_submit/#result_codes
+   */
+  type TransferResultResponse = Readonly<{
+    DATA_TYPE: "transfer_response" | "delete_response";
+    task_id: Globus.UUID;
+    submission_id: Globus.UUID;
+    code: "Accepted" | "Duplicate";
+    message: string;
+    resource: "/transfer" | "/delete";
+    request_id: string;
+  }>;
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task_submit/#transfer_item_fields
+   */
+  type TransferRequestItem = {
+    DATA_TYPE: "transfer_item";
+    source_path: string;
+    destination_path: string;
+    recursive?: boolean;
+    external_checksum?: string;
+    checksum_algorithm?: string;
+  };
+
+  /**
+   * @see https://docs.globus.org/api/transfer/task_submit/#delete_item_fields
+   */
+  type DeleteRequestItem = {
+    DATA_TYPE: "delete_item";
+    path: string;
+  };
+
+  /**
+   * @see https://docs.globus.org/api/transfer/file_operations/#rename_request_fields
+   */
+  type RenameRequest = {
+    DATA_TYPE: "rename";
+    old_path: string;
+    new_path: string;
+  };
+
+  /**
+   * @see https://docs.globus.org/api/transfer/file_operations/#file_document
+   */
+  export interface FileDocument {
+    readonly DATA_TYPE: `${DATA_TYPE.file}`;
+    readonly name: string;
+    readonly type:
+      | "dir"
+      | "file"
+      | "invalid_symlink"
+      | "chr"
+      | "blk"
+      | "pipe"
+      | "other";
+    readonly link_target?: string | null;
+    readonly size?: number;
+    readonly last_modified?: string;
+    readonly permissions?: string;
+    readonly user?: string | null;
+    readonly group?: string | null;
+    readonly link_size?: number | null;
+    readonly link_user?: string | null;
+    readonly link_group?: string | null;
+    readonly link_last_modified?: string | null;
+  }
+
+  /**
+   * @see https://docs.globus.org/api/transfer/file_operations/#file_list_document
+   */
+  export interface FileListDocument extends TransferEntity {
+    readonly DATA_TYPE: `${DATA_TYPE.file_list}`;
+    readonly endpoint: Globus.UUID;
+    readonly path: string;
+    readonly absolute_path: string | null;
+    readonly rename_supported: boolean;
+    readonly symlink_supported: boolean;
+    readonly DATA: FileDocument[];
+    // n.b. This is currently included in responses, but undocumented; use with care.
+    readonly length: number;
+    // n.b. This is currently included in responses, but undocumented; use with care.
+    readonly total: number;
+  }
+
+  type TransferItem = {
+    DATA_TYPE: `${DATA_TYPE.transfer_item}`;
+    source_path: string;
+    destination_path: string;
+    recursive: boolean;
+  };
+
+  type TransferRequest = {
+    DATA_TYPE: `${DATA_TYPE.transfer_request}`;
+    DATA: Array<TransferItem>;
+    deadline: null | string;
+    delete_destination_extra: boolean;
+    destination_endpoint: string;
+    encrypt_data: boolean;
+    fail_on_quota_errors: boolean;
+    filter_rules: null | Array<object>;
+    label: null | string;
+    preserve_timestamp: boolean;
+    skip_source_errors: boolean;
+    source_endpoint: string;
+    submission_id: string;
+    sync_level: null | number;
+    verify_checksum: boolean;
+    notify_on_succeeded: boolean;
+    notify_on_failed: boolean;
+    notify_on_inactive: boolean;
+  };
+}