/** * 腾讯云智能媒资托管服务API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { CalibrateDirectoryStats200Response } from '../models'; import type { CopyDirectory200Response } from '../models'; import type { CopyDirectory202Response } from '../models'; import type { CopyDirectoryRequest } from '../models'; import type { CreateDirectory201Response } from '../models'; import type { CreateDirectoryRequest } from '../models'; import type { DeleteFile200Response } from '../models'; import type { GetDirectoryStats200Response } from '../models'; import type { InfoFileOrDirectory200Response } from '../models'; import type { ListDirectory200Response } from '../models'; import type { ListDirectoryByPage200Response } from '../models'; import type { MoveDirectoryRequest } from '../models'; import type { UpdateDirectoryLabelsRequest } from '../models'; import type { UpdateFileLabelsRequest } from '../models'; /** * DirectoryApi - axios parameter creator */ export declare const DirectoryApiAxiosParamCreator: (configuration?: Configuration) => { /** * 用于修正目录统计数据。 - 目录统计可能因为网络抖动等不确定因素,与实际值存在差异,可以调用此接口对统计值进行修正 - 修正期间,尽量减少对该目录及其子目录的写操作,否则修正结果存在偏差 - 此接口有频控限制,请勿频繁调用 - 要求权限:admin、space_admin * @summary 修正目录统计数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CalibrateDirectoryStatsCalibrateEnum} calibrate 固定值为 1,表示修正目录统计数据 * @param {CalibrateDirectoryStatsStatsTypeEnum} statsType 统计类型,normal 表示普通目录统计量,recycle 表示回收站目录统计量,history 表示目录的历史版本统计量 * @param {string} [recycledId] 回收站项目 ID,修正回收站的统计量时,为必选参数(根目录除外) * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ calibrateDirectoryStats: (libraryId: string, spaceId: string, filePath: string, calibrate: CalibrateDirectoryStatsCalibrateEnum, statsType: CalibrateDirectoryStatsStatsTypeEnum, recycledId?: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于检查目录或相簿状态 * @summary 检查目录或相簿状态 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkDirectoryStatus: (libraryId: string, spaceId: string, filePath: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于复制目录或相簿。 - 自动创建中间所需的各级父目录。 * @summary 复制目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CopyDirectoryRequest} copyDirectoryRequest * @param {CopyDirectoryConflictResolutionStrategyEnum} [conflictResolutionStrategy] 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyDirectory: (libraryId: string, spaceId: string, filePath: string, copyDirectoryRequest: CopyDirectoryRequest, conflictResolutionStrategy?: CopyDirectoryConflictResolutionStrategyEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于创建目录或相簿。 要求权限: admin、space_admin 或 create_directory。 - 媒体类型媒体库可以进一步设置是否为分相簿媒体库,当设置为不分相簿时,则不允许创建目录或相簿,当设置为分相簿时,仅允许创建1层目录或相簿;文件类型媒体库不限制目录层数; - 自动创建中间所需的各级父目录; - 即使 ConflictResolutionStrategy 为 rename,如果路径中的某一父级实际为文件,则依然会返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码。 * @summary 创建目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CreateDirectoryConflictResolutionStrategyEnum} [conflictResolutionStrategy] 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {CreateDirectoryWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {CreateDirectoryRequest} [createDirectoryRequest] 可选的请求体,用于指定目录的元数据信息。如果不需要设置元数据,请求体可以为空。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDirectory: (libraryId: string, spaceId: string, filePath: string, conflictResolutionStrategy?: CreateDirectoryConflictResolutionStrategyEnum, accessToken?: string, librarySecret?: string, userId?: string, withInode?: CreateDirectoryWithInodeEnum, createDirectoryRequest?: CreateDirectoryRequest, options?: RawAxiosRequestConfig) => Promise; /** * 用于删除目录或相簿。如果媒体库启用回收站功能,则该接口不会永久删除目录或相簿,而是将目录或相簿以及其下的文件移入回收站,可通过相关接口永久删除或恢复回收站内的目录或相簿,或直接清空回收站; * @summary 删除目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {DeleteDirectoryPermanentEnum} [permanent] 当媒体库开启回收站时,则该参数指定将文件移入回收站还是永久删除文件,1: 永久删除,0: 移入回收站,默认为 0 * @param {string} [directoryOnly] 当值为 1 或 true 时,只删除目录对象本身,不级联删除子文件和子目录 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDirectory: (libraryId: string, spaceId: string, filePath: string, permanent?: DeleteDirectoryPermanentEnum, directoryOnly?: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查询目录的统计数据,包括子目录数量、文件数量、包含的文件总大小。 - 可以查询普通目录的统计结果、回收站目录的统计结果、某个目录的历史版本的统计结果 - 文件写操作和查询目录统计结果之间存在秒级时延,以最新查询结果为准 * @summary 查询目录统计数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {GetDirectoryStatsStatsEnum} stats 固定值为 1,表示查询目录统计数据 * @param {GetDirectoryStatsStatsTypeEnum} statsType 统计类型,normal 表示普通目录统计量,recycle 表示回收站目录统计量,history 表示目录的历史版本统计量 * @param {string} [recycledId] 回收站项目 ID,查询回收站的统计量时,为必选参数(根目录除外) * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectoryStats: (libraryId: string, spaceId: string, filePath: string, stats: GetDirectoryStatsStatsEnum, statsType: GetDirectoryStatsStatsTypeEnum, recycledId?: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 此接口可同时用于查看文件或文件夹详情,路径如果为文件,则返回文件详情,如果为文件夹,则返回文件夹详情。 * @summary 查看文件、目录或相簿详情 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {InfoFileOrDirectoryInfoEnum} info 固定为 1 * @param {InfoFileOrDirectoryWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {InfoFileOrDirectoryWithFavoriteStatusEnum} [withFavoriteStatus] 是否返回收藏状态,0 或 1,默认不返回 * @param {InfoFileOrDirectoryWithContentCasEnum} [withContentCas] 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 * @param {*} [options] Override http request option. * @throws {RequiredError} */ infoFileOrDirectory: (libraryId: string, spaceId: string, filePath: string, info: InfoFileOrDirectoryInfoEnum, withInode?: InfoFileOrDirectoryWithInodeEnum, accessToken?: string, librarySecret?: string, withFavoriteStatus?: InfoFileOrDirectoryWithFavoriteStatusEnum, withContentCas?: InfoFileOrDirectoryWithContentCasEnum, options?: RawAxiosRequestConfig) => Promise; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 * @summary 列出目录或相簿内容 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {ListDirectoryByMarkerEnum} byMarker 固定传 1,表示使用 marker 方式分页 * @param {string} [marker] 用于顺序列出分页的标识 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,不传默认值20,最大返回1000 * @param {ListDirectoryOrderByEnum} [orderBy] 排序字段 * @param {ListDirectoryOrderByTypeEnum} [orderByType] 排序方式,升序为 asc,降序为 desc * @param {ListDirectoryFilterEnum} [filter] 筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件 * @param {string} [prefix] 按名称前缀过滤,筛选 name 以指定前缀开头的子目录和文件。 仅在 order_by 为 name 或未指定 order_by(默认按 name 排序)时支持该参数。 当 order_by 为其他字段(如 size、modificationTime 等)时,该参数不生效。 * @param {string} [startName] 筛选 name 大于指定值的子目录和文件(大于,不包含等于),用于翻页游标。 仅在 order_by 为 name 或未指定 order_by(默认按 name 排序)时支持该参数。 当 order_by 为其他字段(如 size、modificationTime 等)时,该参数不生效。 * @param {ListDirectorySortTypeEnum} [sortType] 排序方式,不传则文件和文件夹单独排序,先返回文件夹,后返回文件。union 文件和文件夹拉通排序 * @param {ListDirectoryWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {ListDirectoryWithFavoriteStatusEnum} [withFavoriteStatus] 是否返回收藏状态,0 或 1,默认不返回 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {ListDirectoryWithContentCasEnum} [withContentCas] 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectory: (libraryId: string, spaceId: string, filePath: string, byMarker: ListDirectoryByMarkerEnum, marker?: string, limit?: number, orderBy?: ListDirectoryOrderByEnum, orderByType?: ListDirectoryOrderByTypeEnum, filter?: ListDirectoryFilterEnum, prefix?: string, startName?: string, sortType?: ListDirectorySortTypeEnum, withInode?: ListDirectoryWithInodeEnum, withFavoriteStatus?: ListDirectoryWithFavoriteStatusEnum, accessToken?: string, librarySecret?: string, userId?: string, withContentCas?: ListDirectoryWithContentCasEnum, options?: RawAxiosRequestConfig) => Promise; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 page翻页的深度会有限制,强烈建议业务方改用marker翻页的形式。 * @summary 列出目录或相簿内容(传统分页) * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {ListDirectoryByPageByPageEnum} byPage 固定传 1,表示使用 page 方式分页 * @param {number} [page] 分页码,默认第一页,最大翻页的条目数(Page*PageSize的大小)是1万 * @param {number} [pageSize] 分页大小,默认 20,最大翻页的条目数(Page*PageSize的大小)是1万 * @param {ListDirectoryByPageOrderByEnum} [orderBy] 排序字段 * @param {ListDirectoryByPageOrderByTypeEnum} [orderByType] 排序方式,升序为 asc,降序为 desc * @param {ListDirectoryByPageFilterEnum} [filter] 筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件 * @param {ListDirectoryByPageSortTypeEnum} [sortType] 排序方式,不传则文件和文件夹单独排序,先返回文件夹,后返回文件。union 文件和文件夹拉通排序 * @param {ListDirectoryByPageWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {ListDirectoryByPageWithFavoriteStatusEnum} [withFavoriteStatus] 是否返回收藏状态,0 或 1,默认不返回 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {ListDirectoryByPageWithContentCasEnum} [withContentCas] 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectoryByPage: (libraryId: string, spaceId: string, filePath: string, byPage: ListDirectoryByPageByPageEnum, page?: number, pageSize?: number, orderBy?: ListDirectoryByPageOrderByEnum, orderByType?: ListDirectoryByPageOrderByTypeEnum, filter?: ListDirectoryByPageFilterEnum, sortType?: ListDirectoryByPageSortTypeEnum, withInode?: ListDirectoryByPageWithInodeEnum, withFavoriteStatus?: ListDirectoryByPageWithFavoriteStatusEnum, accessToken?: string, librarySecret?: string, userId?: string, withContentCas?: ListDirectoryByPageWithContentCasEnum, options?: RawAxiosRequestConfig) => Promise; /** * 用于重命名或移动目录或相簿。 要求权限: admin、space_admin 或 move_directory。 该接口的源和目标均需要指定完整的目录路径或相簿名;对于文件类型媒体库,源与目标可以跨越多层级多目录,来实现将目录移动到任意其他父目录下的功能,且支持同时修改目录名; 自动创建中间所需的各级父目录。 * @summary 重命名或移动目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {MoveDirectoryRequest} moveDirectoryRequest * @param {MoveDirectoryConflictResolutionStrategyEnum} [conflictResolutionStrategy] 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveDirectory: (libraryId: string, spaceId: string, filePath: string, moveDirectoryRequest: MoveDirectoryRequest, conflictResolutionStrategy?: MoveDirectoryConflictResolutionStrategyEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于更新目录自定义标签或自定义元数据。需要 admin 权限或 spaceAdmin 权限 * @summary 更新目录自定义标签或自定义元数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {UpdateDirectoryLabelsUpdateEnum} update 固定为 1 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {UpdateDirectoryLabelsRequest} [updateDirectoryLabelsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDirectoryLabels: (libraryId: string, spaceId: string, filePath: string, update: UpdateDirectoryLabelsUpdateEnum, accessToken?: string, librarySecret?: string, updateDirectoryLabelsRequest?: UpdateDirectoryLabelsRequest, options?: RawAxiosRequestConfig) => Promise; /** * 用于更新文件的标签(Labels)、分类(Category)或自定义元数据(MetaData)。 需要 admin 权限或 spaceAdmin 权限。 * @summary 更新文件标签、分类或自定义元数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {UpdateFileLabelsUpdateEnum} update 固定为 1 * @param {UpdateFileLabelsRequest} updateFileLabelsRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFileLabels: (libraryId: string, spaceId: string, filePath: string, update: UpdateFileLabelsUpdateEnum, updateFileLabelsRequest: UpdateFileLabelsRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * DirectoryApi - functional programming interface */ export declare const DirectoryApiFp: (configuration?: Configuration) => { /** * 用于修正目录统计数据。 - 目录统计可能因为网络抖动等不确定因素,与实际值存在差异,可以调用此接口对统计值进行修正 - 修正期间,尽量减少对该目录及其子目录的写操作,否则修正结果存在偏差 - 此接口有频控限制,请勿频繁调用 - 要求权限:admin、space_admin * @summary 修正目录统计数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CalibrateDirectoryStatsCalibrateEnum} calibrate 固定值为 1,表示修正目录统计数据 * @param {CalibrateDirectoryStatsStatsTypeEnum} statsType 统计类型,normal 表示普通目录统计量,recycle 表示回收站目录统计量,history 表示目录的历史版本统计量 * @param {string} [recycledId] 回收站项目 ID,修正回收站的统计量时,为必选参数(根目录除外) * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ calibrateDirectoryStats(libraryId: string, spaceId: string, filePath: string, calibrate: CalibrateDirectoryStatsCalibrateEnum, statsType: CalibrateDirectoryStatsStatsTypeEnum, recycledId?: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于检查目录或相簿状态 * @summary 检查目录或相簿状态 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkDirectoryStatus(libraryId: string, spaceId: string, filePath: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于复制目录或相簿。 - 自动创建中间所需的各级父目录。 * @summary 复制目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CopyDirectoryRequest} copyDirectoryRequest * @param {CopyDirectoryConflictResolutionStrategyEnum} [conflictResolutionStrategy] 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyDirectory(libraryId: string, spaceId: string, filePath: string, copyDirectoryRequest: CopyDirectoryRequest, conflictResolutionStrategy?: CopyDirectoryConflictResolutionStrategyEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于创建目录或相簿。 要求权限: admin、space_admin 或 create_directory。 - 媒体类型媒体库可以进一步设置是否为分相簿媒体库,当设置为不分相簿时,则不允许创建目录或相簿,当设置为分相簿时,仅允许创建1层目录或相簿;文件类型媒体库不限制目录层数; - 自动创建中间所需的各级父目录; - 即使 ConflictResolutionStrategy 为 rename,如果路径中的某一父级实际为文件,则依然会返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码。 * @summary 创建目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CreateDirectoryConflictResolutionStrategyEnum} [conflictResolutionStrategy] 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {CreateDirectoryWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {CreateDirectoryRequest} [createDirectoryRequest] 可选的请求体,用于指定目录的元数据信息。如果不需要设置元数据,请求体可以为空。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDirectory(libraryId: string, spaceId: string, filePath: string, conflictResolutionStrategy?: CreateDirectoryConflictResolutionStrategyEnum, accessToken?: string, librarySecret?: string, userId?: string, withInode?: CreateDirectoryWithInodeEnum, createDirectoryRequest?: CreateDirectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于删除目录或相簿。如果媒体库启用回收站功能,则该接口不会永久删除目录或相簿,而是将目录或相簿以及其下的文件移入回收站,可通过相关接口永久删除或恢复回收站内的目录或相簿,或直接清空回收站; * @summary 删除目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {DeleteDirectoryPermanentEnum} [permanent] 当媒体库开启回收站时,则该参数指定将文件移入回收站还是永久删除文件,1: 永久删除,0: 移入回收站,默认为 0 * @param {string} [directoryOnly] 当值为 1 或 true 时,只删除目录对象本身,不级联删除子文件和子目录 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDirectory(libraryId: string, spaceId: string, filePath: string, permanent?: DeleteDirectoryPermanentEnum, directoryOnly?: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查询目录的统计数据,包括子目录数量、文件数量、包含的文件总大小。 - 可以查询普通目录的统计结果、回收站目录的统计结果、某个目录的历史版本的统计结果 - 文件写操作和查询目录统计结果之间存在秒级时延,以最新查询结果为准 * @summary 查询目录统计数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {GetDirectoryStatsStatsEnum} stats 固定值为 1,表示查询目录统计数据 * @param {GetDirectoryStatsStatsTypeEnum} statsType 统计类型,normal 表示普通目录统计量,recycle 表示回收站目录统计量,history 表示目录的历史版本统计量 * @param {string} [recycledId] 回收站项目 ID,查询回收站的统计量时,为必选参数(根目录除外) * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectoryStats(libraryId: string, spaceId: string, filePath: string, stats: GetDirectoryStatsStatsEnum, statsType: GetDirectoryStatsStatsTypeEnum, recycledId?: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 此接口可同时用于查看文件或文件夹详情,路径如果为文件,则返回文件详情,如果为文件夹,则返回文件夹详情。 * @summary 查看文件、目录或相簿详情 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {InfoFileOrDirectoryInfoEnum} info 固定为 1 * @param {InfoFileOrDirectoryWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {InfoFileOrDirectoryWithFavoriteStatusEnum} [withFavoriteStatus] 是否返回收藏状态,0 或 1,默认不返回 * @param {InfoFileOrDirectoryWithContentCasEnum} [withContentCas] 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 * @param {*} [options] Override http request option. * @throws {RequiredError} */ infoFileOrDirectory(libraryId: string, spaceId: string, filePath: string, info: InfoFileOrDirectoryInfoEnum, withInode?: InfoFileOrDirectoryWithInodeEnum, accessToken?: string, librarySecret?: string, withFavoriteStatus?: InfoFileOrDirectoryWithFavoriteStatusEnum, withContentCas?: InfoFileOrDirectoryWithContentCasEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 * @summary 列出目录或相簿内容 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {ListDirectoryByMarkerEnum} byMarker 固定传 1,表示使用 marker 方式分页 * @param {string} [marker] 用于顺序列出分页的标识 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,不传默认值20,最大返回1000 * @param {ListDirectoryOrderByEnum} [orderBy] 排序字段 * @param {ListDirectoryOrderByTypeEnum} [orderByType] 排序方式,升序为 asc,降序为 desc * @param {ListDirectoryFilterEnum} [filter] 筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件 * @param {string} [prefix] 按名称前缀过滤,筛选 name 以指定前缀开头的子目录和文件。 仅在 order_by 为 name 或未指定 order_by(默认按 name 排序)时支持该参数。 当 order_by 为其他字段(如 size、modificationTime 等)时,该参数不生效。 * @param {string} [startName] 筛选 name 大于指定值的子目录和文件(大于,不包含等于),用于翻页游标。 仅在 order_by 为 name 或未指定 order_by(默认按 name 排序)时支持该参数。 当 order_by 为其他字段(如 size、modificationTime 等)时,该参数不生效。 * @param {ListDirectorySortTypeEnum} [sortType] 排序方式,不传则文件和文件夹单独排序,先返回文件夹,后返回文件。union 文件和文件夹拉通排序 * @param {ListDirectoryWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {ListDirectoryWithFavoriteStatusEnum} [withFavoriteStatus] 是否返回收藏状态,0 或 1,默认不返回 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {ListDirectoryWithContentCasEnum} [withContentCas] 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectory(libraryId: string, spaceId: string, filePath: string, byMarker: ListDirectoryByMarkerEnum, marker?: string, limit?: number, orderBy?: ListDirectoryOrderByEnum, orderByType?: ListDirectoryOrderByTypeEnum, filter?: ListDirectoryFilterEnum, prefix?: string, startName?: string, sortType?: ListDirectorySortTypeEnum, withInode?: ListDirectoryWithInodeEnum, withFavoriteStatus?: ListDirectoryWithFavoriteStatusEnum, accessToken?: string, librarySecret?: string, userId?: string, withContentCas?: ListDirectoryWithContentCasEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 page翻页的深度会有限制,强烈建议业务方改用marker翻页的形式。 * @summary 列出目录或相簿内容(传统分页) * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {ListDirectoryByPageByPageEnum} byPage 固定传 1,表示使用 page 方式分页 * @param {number} [page] 分页码,默认第一页,最大翻页的条目数(Page*PageSize的大小)是1万 * @param {number} [pageSize] 分页大小,默认 20,最大翻页的条目数(Page*PageSize的大小)是1万 * @param {ListDirectoryByPageOrderByEnum} [orderBy] 排序字段 * @param {ListDirectoryByPageOrderByTypeEnum} [orderByType] 排序方式,升序为 asc,降序为 desc * @param {ListDirectoryByPageFilterEnum} [filter] 筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件 * @param {ListDirectoryByPageSortTypeEnum} [sortType] 排序方式,不传则文件和文件夹单独排序,先返回文件夹,后返回文件。union 文件和文件夹拉通排序 * @param {ListDirectoryByPageWithInodeEnum} [withInode] 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 * @param {ListDirectoryByPageWithFavoriteStatusEnum} [withFavoriteStatus] 是否返回收藏状态,0 或 1,默认不返回 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {ListDirectoryByPageWithContentCasEnum} [withContentCas] 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectoryByPage(libraryId: string, spaceId: string, filePath: string, byPage: ListDirectoryByPageByPageEnum, page?: number, pageSize?: number, orderBy?: ListDirectoryByPageOrderByEnum, orderByType?: ListDirectoryByPageOrderByTypeEnum, filter?: ListDirectoryByPageFilterEnum, sortType?: ListDirectoryByPageSortTypeEnum, withInode?: ListDirectoryByPageWithInodeEnum, withFavoriteStatus?: ListDirectoryByPageWithFavoriteStatusEnum, accessToken?: string, librarySecret?: string, userId?: string, withContentCas?: ListDirectoryByPageWithContentCasEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于重命名或移动目录或相簿。 要求权限: admin、space_admin 或 move_directory。 该接口的源和目标均需要指定完整的目录路径或相簿名;对于文件类型媒体库,源与目标可以跨越多层级多目录,来实现将目录移动到任意其他父目录下的功能,且支持同时修改目录名; 自动创建中间所需的各级父目录。 * @summary 重命名或移动目录或相簿 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {MoveDirectoryRequest} moveDirectoryRequest * @param {MoveDirectoryConflictResolutionStrategyEnum} [conflictResolutionStrategy] 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveDirectory(libraryId: string, spaceId: string, filePath: string, moveDirectoryRequest: MoveDirectoryRequest, conflictResolutionStrategy?: MoveDirectoryConflictResolutionStrategyEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于更新目录自定义标签或自定义元数据。需要 admin 权限或 spaceAdmin 权限 * @summary 更新目录自定义标签或自定义元数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {UpdateDirectoryLabelsUpdateEnum} update 固定为 1 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {UpdateDirectoryLabelsRequest} [updateDirectoryLabelsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDirectoryLabels(libraryId: string, spaceId: string, filePath: string, update: UpdateDirectoryLabelsUpdateEnum, accessToken?: string, librarySecret?: string, updateDirectoryLabelsRequest?: UpdateDirectoryLabelsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于更新文件的标签(Labels)、分类(Category)或自定义元数据(MetaData)。 需要 admin 权限或 spaceAdmin 权限。 * @summary 更新文件标签、分类或自定义元数据 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {UpdateFileLabelsUpdateEnum} update 固定为 1 * @param {UpdateFileLabelsRequest} updateFileLabelsRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFileLabels(libraryId: string, spaceId: string, filePath: string, update: UpdateFileLabelsUpdateEnum, updateFileLabelsRequest: UpdateFileLabelsRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DirectoryApi - factory interface */ export declare const DirectoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 用于修正目录统计数据。 - 目录统计可能因为网络抖动等不确定因素,与实际值存在差异,可以调用此接口对统计值进行修正 - 修正期间,尽量减少对该目录及其子目录的写操作,否则修正结果存在偏差 - 此接口有频控限制,请勿频繁调用 - 要求权限:admin、space_admin * @summary 修正目录统计数据 * @param {DirectoryApiCalibrateDirectoryStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ calibrateDirectoryStats(requestParameters: DirectoryApiCalibrateDirectoryStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于检查目录或相簿状态 * @summary 检查目录或相簿状态 * @param {DirectoryApiCheckDirectoryStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkDirectoryStatus(requestParameters: DirectoryApiCheckDirectoryStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于复制目录或相簿。 - 自动创建中间所需的各级父目录。 * @summary 复制目录或相簿 * @param {DirectoryApiCopyDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyDirectory(requestParameters: DirectoryApiCopyDirectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于创建目录或相簿。 要求权限: admin、space_admin 或 create_directory。 - 媒体类型媒体库可以进一步设置是否为分相簿媒体库,当设置为不分相簿时,则不允许创建目录或相簿,当设置为分相簿时,仅允许创建1层目录或相簿;文件类型媒体库不限制目录层数; - 自动创建中间所需的各级父目录; - 即使 ConflictResolutionStrategy 为 rename,如果路径中的某一父级实际为文件,则依然会返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码。 * @summary 创建目录或相簿 * @param {DirectoryApiCreateDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDirectory(requestParameters: DirectoryApiCreateDirectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于删除目录或相簿。如果媒体库启用回收站功能,则该接口不会永久删除目录或相簿,而是将目录或相簿以及其下的文件移入回收站,可通过相关接口永久删除或恢复回收站内的目录或相簿,或直接清空回收站; * @summary 删除目录或相簿 * @param {DirectoryApiDeleteDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDirectory(requestParameters: DirectoryApiDeleteDirectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查询目录的统计数据,包括子目录数量、文件数量、包含的文件总大小。 - 可以查询普通目录的统计结果、回收站目录的统计结果、某个目录的历史版本的统计结果 - 文件写操作和查询目录统计结果之间存在秒级时延,以最新查询结果为准 * @summary 查询目录统计数据 * @param {DirectoryApiGetDirectoryStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectoryStats(requestParameters: DirectoryApiGetDirectoryStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 此接口可同时用于查看文件或文件夹详情,路径如果为文件,则返回文件详情,如果为文件夹,则返回文件夹详情。 * @summary 查看文件、目录或相簿详情 * @param {DirectoryApiInfoFileOrDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ infoFileOrDirectory(requestParameters: DirectoryApiInfoFileOrDirectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 * @summary 列出目录或相簿内容 * @param {DirectoryApiListDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectory(requestParameters: DirectoryApiListDirectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 page翻页的深度会有限制,强烈建议业务方改用marker翻页的形式。 * @summary 列出目录或相簿内容(传统分页) * @param {DirectoryApiListDirectoryByPageRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectoryByPage(requestParameters: DirectoryApiListDirectoryByPageRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于重命名或移动目录或相簿。 要求权限: admin、space_admin 或 move_directory。 该接口的源和目标均需要指定完整的目录路径或相簿名;对于文件类型媒体库,源与目标可以跨越多层级多目录,来实现将目录移动到任意其他父目录下的功能,且支持同时修改目录名; 自动创建中间所需的各级父目录。 * @summary 重命名或移动目录或相簿 * @param {DirectoryApiMoveDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveDirectory(requestParameters: DirectoryApiMoveDirectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于更新目录自定义标签或自定义元数据。需要 admin 权限或 spaceAdmin 权限 * @summary 更新目录自定义标签或自定义元数据 * @param {DirectoryApiUpdateDirectoryLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDirectoryLabels(requestParameters: DirectoryApiUpdateDirectoryLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于更新文件的标签(Labels)、分类(Category)或自定义元数据(MetaData)。 需要 admin 权限或 spaceAdmin 权限。 * @summary 更新文件标签、分类或自定义元数据 * @param {DirectoryApiUpdateFileLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFileLabels(requestParameters: DirectoryApiUpdateFileLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for calibrateDirectoryStats operation in DirectoryApi. */ export interface DirectoryApiCalibrateDirectoryStatsRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定值为 1,表示修正目录统计数据 */ readonly calibrate: CalibrateDirectoryStatsCalibrateEnum; /** * 统计类型,normal 表示普通目录统计量,recycle 表示回收站目录统计量,history 表示目录的历史版本统计量 */ readonly statsType: CalibrateDirectoryStatsStatsTypeEnum; /** * 回收站项目 ID,修正回收站的统计量时,为必选参数(根目录除外) */ readonly recycledId?: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for checkDirectoryStatus operation in DirectoryApi. */ export interface DirectoryApiCheckDirectoryStatusRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for copyDirectory operation in DirectoryApi. */ export interface DirectoryApiCopyDirectoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; readonly copyDirectoryRequest: CopyDirectoryRequest; /** * 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask */ readonly conflictResolutionStrategy?: CopyDirectoryConflictResolutionStrategyEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for createDirectory operation in DirectoryApi. */ export interface DirectoryApiCreateDirectoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask */ readonly conflictResolutionStrategy?: CreateDirectoryConflictResolutionStrategyEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 */ readonly withInode?: CreateDirectoryWithInodeEnum; /** * 可选的请求体,用于指定目录的元数据信息。如果不需要设置元数据,请求体可以为空。 */ readonly createDirectoryRequest?: CreateDirectoryRequest; } /** * Request parameters for deleteDirectory operation in DirectoryApi. */ export interface DirectoryApiDeleteDirectoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 当媒体库开启回收站时,则该参数指定将文件移入回收站还是永久删除文件,1: 永久删除,0: 移入回收站,默认为 0 */ readonly permanent?: DeleteDirectoryPermanentEnum; /** * 当值为 1 或 true 时,只删除目录对象本身,不级联删除子文件和子目录 */ readonly directoryOnly?: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for getDirectoryStats operation in DirectoryApi. */ export interface DirectoryApiGetDirectoryStatsRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定值为 1,表示查询目录统计数据 */ readonly stats: GetDirectoryStatsStatsEnum; /** * 统计类型,normal 表示普通目录统计量,recycle 表示回收站目录统计量,history 表示目录的历史版本统计量 */ readonly statsType: GetDirectoryStatsStatsTypeEnum; /** * 回收站项目 ID,查询回收站的统计量时,为必选参数(根目录除外) */ readonly recycledId?: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for infoFileOrDirectory operation in DirectoryApi. */ export interface DirectoryApiInfoFileOrDirectoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定为 1 */ readonly info: InfoFileOrDirectoryInfoEnum; /** * 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 */ readonly withInode?: InfoFileOrDirectoryWithInodeEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 是否返回收藏状态,0 或 1,默认不返回 */ readonly withFavoriteStatus?: InfoFileOrDirectoryWithFavoriteStatusEnum; /** * 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 */ readonly withContentCas?: InfoFileOrDirectoryWithContentCasEnum; } /** * Request parameters for listDirectory operation in DirectoryApi. */ export interface DirectoryApiListDirectoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定传 1,表示使用 marker 方式分页 */ readonly byMarker: ListDirectoryByMarkerEnum; /** * 用于顺序列出分页的标识 */ readonly marker?: string; /** * 用于顺序列出分页时本地列出的项目数限制,不传默认值20,最大返回1000 */ readonly limit?: number; /** * 排序字段 */ readonly orderBy?: ListDirectoryOrderByEnum; /** * 排序方式,升序为 asc,降序为 desc */ readonly orderByType?: ListDirectoryOrderByTypeEnum; /** * 筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件 */ readonly filter?: ListDirectoryFilterEnum; /** * 按名称前缀过滤,筛选 name 以指定前缀开头的子目录和文件。 仅在 order_by 为 name 或未指定 order_by(默认按 name 排序)时支持该参数。 当 order_by 为其他字段(如 size、modificationTime 等)时,该参数不生效。 */ readonly prefix?: string; /** * 筛选 name 大于指定值的子目录和文件(大于,不包含等于),用于翻页游标。 仅在 order_by 为 name 或未指定 order_by(默认按 name 排序)时支持该参数。 当 order_by 为其他字段(如 size、modificationTime 等)时,该参数不生效。 */ readonly startName?: string; /** * 排序方式,不传则文件和文件夹单独排序,先返回文件夹,后返回文件。union 文件和文件夹拉通排序 */ readonly sortType?: ListDirectorySortTypeEnum; /** * 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 */ readonly withInode?: ListDirectoryWithInodeEnum; /** * 是否返回收藏状态,0 或 1,默认不返回 */ readonly withFavoriteStatus?: ListDirectoryWithFavoriteStatusEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 */ readonly withContentCas?: ListDirectoryWithContentCasEnum; } /** * Request parameters for listDirectoryByPage operation in DirectoryApi. */ export interface DirectoryApiListDirectoryByPageRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定传 1,表示使用 page 方式分页 */ readonly byPage: ListDirectoryByPageByPageEnum; /** * 分页码,默认第一页,最大翻页的条目数(Page*PageSize的大小)是1万 */ readonly page?: number; /** * 分页大小,默认 20,最大翻页的条目数(Page*PageSize的大小)是1万 */ readonly pageSize?: number; /** * 排序字段 */ readonly orderBy?: ListDirectoryByPageOrderByEnum; /** * 排序方式,升序为 asc,降序为 desc */ readonly orderByType?: ListDirectoryByPageOrderByTypeEnum; /** * 筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件 */ readonly filter?: ListDirectoryByPageFilterEnum; /** * 排序方式,不传则文件和文件夹单独排序,先返回文件夹,后返回文件。union 文件和文件夹拉通排序 */ readonly sortType?: ListDirectoryByPageSortTypeEnum; /** * 是否返回 inode,即文件目录 ID,0 或 1,默认不返回 */ readonly withInode?: ListDirectoryByPageWithInodeEnum; /** * 是否返回收藏状态,0 或 1,默认不返回 */ readonly withFavoriteStatus?: ListDirectoryByPageWithFavoriteStatusEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 0 或 1,是否返回文件内容的Cas标识,可选,默认不返回 */ readonly withContentCas?: ListDirectoryByPageWithContentCasEnum; } /** * Request parameters for moveDirectory operation in DirectoryApi. */ export interface DirectoryApiMoveDirectoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; readonly moveDirectoryRequest: MoveDirectoryRequest; /** * 最后一级目录冲突时的处理方式,ask冲突时返回 HTTP 409,rename冲突时自动重命名最后一级目录,默认为 ask */ readonly conflictResolutionStrategy?: MoveDirectoryConflictResolutionStrategyEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for updateDirectoryLabels operation in DirectoryApi. */ export interface DirectoryApiUpdateDirectoryLabelsRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定为 1 */ readonly update: UpdateDirectoryLabelsUpdateEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; readonly updateDirectoryLabelsRequest?: UpdateDirectoryLabelsRequest; } /** * Request parameters for updateFileLabels operation in DirectoryApi. */ export interface DirectoryApiUpdateFileLabelsRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 固定为 1 */ readonly update: UpdateFileLabelsUpdateEnum; readonly updateFileLabelsRequest: UpdateFileLabelsRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * DirectoryApi - object-oriented interface */ export declare class DirectoryApi extends BaseAPI { /** * 用于修正目录统计数据。 - 目录统计可能因为网络抖动等不确定因素,与实际值存在差异,可以调用此接口对统计值进行修正 - 修正期间,尽量减少对该目录及其子目录的写操作,否则修正结果存在偏差 - 此接口有频控限制,请勿频繁调用 - 要求权限:admin、space_admin * @summary 修正目录统计数据 * @param {DirectoryApiCalibrateDirectoryStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ calibrateDirectoryStats(requestParameters: DirectoryApiCalibrateDirectoryStatsRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于检查目录或相簿状态 * @summary 检查目录或相簿状态 * @param {DirectoryApiCheckDirectoryStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkDirectoryStatus(requestParameters: DirectoryApiCheckDirectoryStatusRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于复制目录或相簿。 - 自动创建中间所需的各级父目录。 * @summary 复制目录或相簿 * @param {DirectoryApiCopyDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyDirectory(requestParameters: DirectoryApiCopyDirectoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于创建目录或相簿。 要求权限: admin、space_admin 或 create_directory。 - 媒体类型媒体库可以进一步设置是否为分相簿媒体库,当设置为不分相簿时,则不允许创建目录或相簿,当设置为分相簿时,仅允许创建1层目录或相簿;文件类型媒体库不限制目录层数; - 自动创建中间所需的各级父目录; - 即使 ConflictResolutionStrategy 为 rename,如果路径中的某一父级实际为文件,则依然会返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码。 * @summary 创建目录或相簿 * @param {DirectoryApiCreateDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDirectory(requestParameters: DirectoryApiCreateDirectoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于删除目录或相簿。如果媒体库启用回收站功能,则该接口不会永久删除目录或相簿,而是将目录或相簿以及其下的文件移入回收站,可通过相关接口永久删除或恢复回收站内的目录或相簿,或直接清空回收站; * @summary 删除目录或相簿 * @param {DirectoryApiDeleteDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDirectory(requestParameters: DirectoryApiDeleteDirectoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查询目录的统计数据,包括子目录数量、文件数量、包含的文件总大小。 - 可以查询普通目录的统计结果、回收站目录的统计结果、某个目录的历史版本的统计结果 - 文件写操作和查询目录统计结果之间存在秒级时延,以最新查询结果为准 * @summary 查询目录统计数据 * @param {DirectoryApiGetDirectoryStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectoryStats(requestParameters: DirectoryApiGetDirectoryStatsRequest, options?: RawAxiosRequestConfig): Promise>; /** * 此接口可同时用于查看文件或文件夹详情,路径如果为文件,则返回文件详情,如果为文件夹,则返回文件夹详情。 * @summary 查看文件、目录或相簿详情 * @param {DirectoryApiInfoFileOrDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ infoFileOrDirectory(requestParameters: DirectoryApiInfoFileOrDirectoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 * @summary 列出目录或相簿内容 * @param {DirectoryApiListDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectory(requestParameters: DirectoryApiListDirectoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于列出目录或相簿内容。 目录内容的列出顺序为:首先按照字典序列出子目录,随后根据上传时间列出媒体库中的媒体资源,或根据文件名列出文件库中的文件资源。 page翻页的深度会有限制,强烈建议业务方改用marker翻页的形式。 * @summary 列出目录或相簿内容(传统分页) * @param {DirectoryApiListDirectoryByPageRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDirectoryByPage(requestParameters: DirectoryApiListDirectoryByPageRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于重命名或移动目录或相簿。 要求权限: admin、space_admin 或 move_directory。 该接口的源和目标均需要指定完整的目录路径或相簿名;对于文件类型媒体库,源与目标可以跨越多层级多目录,来实现将目录移动到任意其他父目录下的功能,且支持同时修改目录名; 自动创建中间所需的各级父目录。 * @summary 重命名或移动目录或相簿 * @param {DirectoryApiMoveDirectoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveDirectory(requestParameters: DirectoryApiMoveDirectoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于更新目录自定义标签或自定义元数据。需要 admin 权限或 spaceAdmin 权限 * @summary 更新目录自定义标签或自定义元数据 * @param {DirectoryApiUpdateDirectoryLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDirectoryLabels(requestParameters: DirectoryApiUpdateDirectoryLabelsRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于更新文件的标签(Labels)、分类(Category)或自定义元数据(MetaData)。 需要 admin 权限或 spaceAdmin 权限。 * @summary 更新文件标签、分类或自定义元数据 * @param {DirectoryApiUpdateFileLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFileLabels(requestParameters: DirectoryApiUpdateFileLabelsRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const CalibrateDirectoryStatsCalibrateEnum: { readonly NUMBER_1: 1; }; export type CalibrateDirectoryStatsCalibrateEnum = typeof CalibrateDirectoryStatsCalibrateEnum[keyof typeof CalibrateDirectoryStatsCalibrateEnum]; export declare const CalibrateDirectoryStatsStatsTypeEnum: { readonly Normal: "normal"; readonly Recycle: "recycle"; readonly History: "history"; }; export type CalibrateDirectoryStatsStatsTypeEnum = typeof CalibrateDirectoryStatsStatsTypeEnum[keyof typeof CalibrateDirectoryStatsStatsTypeEnum]; export declare const CopyDirectoryConflictResolutionStrategyEnum: { readonly Ask: "ask"; readonly Rename: "rename"; }; export type CopyDirectoryConflictResolutionStrategyEnum = typeof CopyDirectoryConflictResolutionStrategyEnum[keyof typeof CopyDirectoryConflictResolutionStrategyEnum]; export declare const CreateDirectoryConflictResolutionStrategyEnum: { readonly Ask: "ask"; readonly Rename: "rename"; }; export type CreateDirectoryConflictResolutionStrategyEnum = typeof CreateDirectoryConflictResolutionStrategyEnum[keyof typeof CreateDirectoryConflictResolutionStrategyEnum]; export declare const CreateDirectoryWithInodeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type CreateDirectoryWithInodeEnum = typeof CreateDirectoryWithInodeEnum[keyof typeof CreateDirectoryWithInodeEnum]; export declare const DeleteDirectoryPermanentEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type DeleteDirectoryPermanentEnum = typeof DeleteDirectoryPermanentEnum[keyof typeof DeleteDirectoryPermanentEnum]; export declare const GetDirectoryStatsStatsEnum: { readonly NUMBER_1: 1; }; export type GetDirectoryStatsStatsEnum = typeof GetDirectoryStatsStatsEnum[keyof typeof GetDirectoryStatsStatsEnum]; export declare const GetDirectoryStatsStatsTypeEnum: { readonly Normal: "normal"; readonly Recycle: "recycle"; readonly History: "history"; }; export type GetDirectoryStatsStatsTypeEnum = typeof GetDirectoryStatsStatsTypeEnum[keyof typeof GetDirectoryStatsStatsTypeEnum]; export declare const InfoFileOrDirectoryInfoEnum: { readonly NUMBER_1: 1; }; export type InfoFileOrDirectoryInfoEnum = typeof InfoFileOrDirectoryInfoEnum[keyof typeof InfoFileOrDirectoryInfoEnum]; export declare const InfoFileOrDirectoryWithInodeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type InfoFileOrDirectoryWithInodeEnum = typeof InfoFileOrDirectoryWithInodeEnum[keyof typeof InfoFileOrDirectoryWithInodeEnum]; export declare const InfoFileOrDirectoryWithFavoriteStatusEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type InfoFileOrDirectoryWithFavoriteStatusEnum = typeof InfoFileOrDirectoryWithFavoriteStatusEnum[keyof typeof InfoFileOrDirectoryWithFavoriteStatusEnum]; export declare const InfoFileOrDirectoryWithContentCasEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type InfoFileOrDirectoryWithContentCasEnum = typeof InfoFileOrDirectoryWithContentCasEnum[keyof typeof InfoFileOrDirectoryWithContentCasEnum]; export declare const ListDirectoryByMarkerEnum: { readonly NUMBER_1: 1; }; export type ListDirectoryByMarkerEnum = typeof ListDirectoryByMarkerEnum[keyof typeof ListDirectoryByMarkerEnum]; export declare const ListDirectoryOrderByEnum: { readonly Name: "name"; readonly ModificationTime: "modificationTime"; readonly Size: "size"; readonly CreationTime: "creationTime"; readonly LocalCreationTime: "localCreationTime"; }; export type ListDirectoryOrderByEnum = typeof ListDirectoryOrderByEnum[keyof typeof ListDirectoryOrderByEnum]; export declare const ListDirectoryOrderByTypeEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type ListDirectoryOrderByTypeEnum = typeof ListDirectoryOrderByTypeEnum[keyof typeof ListDirectoryOrderByTypeEnum]; export declare const ListDirectoryFilterEnum: { readonly OnlyDir: "onlyDir"; readonly OnlyFile: "onlyFile"; }; export type ListDirectoryFilterEnum = typeof ListDirectoryFilterEnum[keyof typeof ListDirectoryFilterEnum]; export declare const ListDirectorySortTypeEnum: { readonly Union: "union"; }; export type ListDirectorySortTypeEnum = typeof ListDirectorySortTypeEnum[keyof typeof ListDirectorySortTypeEnum]; export declare const ListDirectoryWithInodeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListDirectoryWithInodeEnum = typeof ListDirectoryWithInodeEnum[keyof typeof ListDirectoryWithInodeEnum]; export declare const ListDirectoryWithFavoriteStatusEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListDirectoryWithFavoriteStatusEnum = typeof ListDirectoryWithFavoriteStatusEnum[keyof typeof ListDirectoryWithFavoriteStatusEnum]; export declare const ListDirectoryWithContentCasEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListDirectoryWithContentCasEnum = typeof ListDirectoryWithContentCasEnum[keyof typeof ListDirectoryWithContentCasEnum]; export declare const ListDirectoryByPageByPageEnum: { readonly NUMBER_1: 1; }; export type ListDirectoryByPageByPageEnum = typeof ListDirectoryByPageByPageEnum[keyof typeof ListDirectoryByPageByPageEnum]; export declare const ListDirectoryByPageOrderByEnum: { readonly Name: "name"; readonly ModificationTime: "modificationTime"; readonly Size: "size"; readonly CreationTime: "creationTime"; readonly LocalCreationTime: "localCreationTime"; }; export type ListDirectoryByPageOrderByEnum = typeof ListDirectoryByPageOrderByEnum[keyof typeof ListDirectoryByPageOrderByEnum]; export declare const ListDirectoryByPageOrderByTypeEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type ListDirectoryByPageOrderByTypeEnum = typeof ListDirectoryByPageOrderByTypeEnum[keyof typeof ListDirectoryByPageOrderByTypeEnum]; export declare const ListDirectoryByPageFilterEnum: { readonly OnlyDir: "onlyDir"; readonly OnlyFile: "onlyFile"; }; export type ListDirectoryByPageFilterEnum = typeof ListDirectoryByPageFilterEnum[keyof typeof ListDirectoryByPageFilterEnum]; export declare const ListDirectoryByPageSortTypeEnum: { readonly Union: "union"; }; export type ListDirectoryByPageSortTypeEnum = typeof ListDirectoryByPageSortTypeEnum[keyof typeof ListDirectoryByPageSortTypeEnum]; export declare const ListDirectoryByPageWithInodeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListDirectoryByPageWithInodeEnum = typeof ListDirectoryByPageWithInodeEnum[keyof typeof ListDirectoryByPageWithInodeEnum]; export declare const ListDirectoryByPageWithFavoriteStatusEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListDirectoryByPageWithFavoriteStatusEnum = typeof ListDirectoryByPageWithFavoriteStatusEnum[keyof typeof ListDirectoryByPageWithFavoriteStatusEnum]; export declare const ListDirectoryByPageWithContentCasEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListDirectoryByPageWithContentCasEnum = typeof ListDirectoryByPageWithContentCasEnum[keyof typeof ListDirectoryByPageWithContentCasEnum]; export declare const MoveDirectoryConflictResolutionStrategyEnum: { readonly Ask: "ask"; readonly Rename: "rename"; }; export type MoveDirectoryConflictResolutionStrategyEnum = typeof MoveDirectoryConflictResolutionStrategyEnum[keyof typeof MoveDirectoryConflictResolutionStrategyEnum]; export declare const UpdateDirectoryLabelsUpdateEnum: { readonly NUMBER_1: 1; }; export type UpdateDirectoryLabelsUpdateEnum = typeof UpdateDirectoryLabelsUpdateEnum[keyof typeof UpdateDirectoryLabelsUpdateEnum]; export declare const UpdateFileLabelsUpdateEnum: { readonly NUMBER_1: 1; }; export type UpdateFileLabelsUpdateEnum = typeof UpdateFileLabelsUpdateEnum[keyof typeof UpdateFileLabelsUpdateEnum];