/** * 腾讯云智能媒资托管服务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 { EmptyHistory202Response } from '../models'; import type { GetHistoryConfig200Response } from '../models'; import type { ListHistory200Response } from '../models'; import type { SetHistoryConfigRequest } from '../models'; import type { SetHistoryLatest200Response } from '../models'; /** * HistoryApi - axios parameter creator */ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration) => { /** * 用于删除特定历史版本。权限要求:delete_history权限、admin权限或space_admin权限 * @summary 删除历史版本 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {Array} requestBody * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteHistory: (libraryId: string, spaceId: string, requestBody: Array, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于清空整个library的历史版本,请求此接口时,需要先关闭历史版本。注意:此接口会清空整个library全部文件的历史版本,相应的空间会释放,不可找回数据,请谨慎操作!此接口有频控限制,每分钟最多调用1次,请勿频繁调用。权限要求:admin权限 * @summary 清空历史版本 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ emptyHistory: (libraryId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查询历史版本配置信息。权限要求:admin权限 * @summary 查询历史版本配置信息 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHistoryConfig: (libraryId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查看历史版本列表。 * @summary 查看历史版本列表 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径,对于多级目录,使用斜杠(/)分隔,例如 foo/bar.txt * @param {string} [marker] 用于顺序列出分页的标识 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,默认为 20;若不指定任何翻页参数,默认采用(marker,limit)参数翻页;若与(page,page_size)参数同时使用,默认采用(page,page_size)参数翻页 * @param {number} [page] 分页码,默认第一页 * @param {number} [pageSize] 分页大小,默认 20;若与(marker,limit)参数同时使用,默认采用(page,page_size)参数翻页 * @param {ListHistoryOrderByEnum} [orderBy] 排序字段,按文件 id 排序为 id,按创建时间排序为 creationTime,默认为 id,最新版本排序始终在首位 * @param {ListHistoryOrderByTypeEnum} [orderByType] 排序方式,升序为 asc,降序为 desc,默认为 desc * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHistory: (libraryId: string, spaceId: string, filePath: string, marker?: string, limit?: number, page?: number, pageSize?: number, orderBy?: ListHistoryOrderByEnum, orderByType?: ListHistoryOrderByTypeEnum, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于设置历史版本配置信息。权限要求:admin权限。多次调用接口会覆盖之前设置,以最后一次调用为准。更新时,可以设置部分字段;未传入字段,其值保持不变。配置设置生效可能有 1 分钟左右延迟。 * @summary 设置历史版本配置信息 * @param {string} libraryId 媒体库 ID,必选参数 * @param {SetHistoryConfigRequest} setHistoryConfigRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryConfig: (libraryId: string, setHistoryConfigRequest: SetHistoryConfigRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于设置历史版本为最新版本。权限要求:admin权限、space_admin权限或set_history_latest权限 * @summary 设置历史版本为最新版本 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} historyId 历史版本 ID * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryLatest: (libraryId: string, spaceId: string, historyId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * HistoryApi - functional programming interface */ export declare const HistoryApiFp: (configuration?: Configuration) => { /** * 用于删除特定历史版本。权限要求:delete_history权限、admin权限或space_admin权限 * @summary 删除历史版本 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {Array} requestBody * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteHistory(libraryId: string, spaceId: string, requestBody: Array, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于清空整个library的历史版本,请求此接口时,需要先关闭历史版本。注意:此接口会清空整个library全部文件的历史版本,相应的空间会释放,不可找回数据,请谨慎操作!此接口有频控限制,每分钟最多调用1次,请勿频繁调用。权限要求:admin权限 * @summary 清空历史版本 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ emptyHistory(libraryId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查询历史版本配置信息。权限要求:admin权限 * @summary 查询历史版本配置信息 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHistoryConfig(libraryId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查看历史版本列表。 * @summary 查看历史版本列表 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径,对于多级目录,使用斜杠(/)分隔,例如 foo/bar.txt * @param {string} [marker] 用于顺序列出分页的标识 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,默认为 20;若不指定任何翻页参数,默认采用(marker,limit)参数翻页;若与(page,page_size)参数同时使用,默认采用(page,page_size)参数翻页 * @param {number} [page] 分页码,默认第一页 * @param {number} [pageSize] 分页大小,默认 20;若与(marker,limit)参数同时使用,默认采用(page,page_size)参数翻页 * @param {ListHistoryOrderByEnum} [orderBy] 排序字段,按文件 id 排序为 id,按创建时间排序为 creationTime,默认为 id,最新版本排序始终在首位 * @param {ListHistoryOrderByTypeEnum} [orderByType] 排序方式,升序为 asc,降序为 desc,默认为 desc * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHistory(libraryId: string, spaceId: string, filePath: string, marker?: string, limit?: number, page?: number, pageSize?: number, orderBy?: ListHistoryOrderByEnum, orderByType?: ListHistoryOrderByTypeEnum, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于设置历史版本配置信息。权限要求:admin权限。多次调用接口会覆盖之前设置,以最后一次调用为准。更新时,可以设置部分字段;未传入字段,其值保持不变。配置设置生效可能有 1 分钟左右延迟。 * @summary 设置历史版本配置信息 * @param {string} libraryId 媒体库 ID,必选参数 * @param {SetHistoryConfigRequest} setHistoryConfigRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryConfig(libraryId: string, setHistoryConfigRequest: SetHistoryConfigRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于设置历史版本为最新版本。权限要求:admin权限、space_admin权限或set_history_latest权限 * @summary 设置历史版本为最新版本 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} historyId 历史版本 ID * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryLatest(libraryId: string, spaceId: string, historyId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * HistoryApi - factory interface */ export declare const HistoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 用于删除特定历史版本。权限要求:delete_history权限、admin权限或space_admin权限 * @summary 删除历史版本 * @param {HistoryApiDeleteHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteHistory(requestParameters: HistoryApiDeleteHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于清空整个library的历史版本,请求此接口时,需要先关闭历史版本。注意:此接口会清空整个library全部文件的历史版本,相应的空间会释放,不可找回数据,请谨慎操作!此接口有频控限制,每分钟最多调用1次,请勿频繁调用。权限要求:admin权限 * @summary 清空历史版本 * @param {HistoryApiEmptyHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ emptyHistory(requestParameters: HistoryApiEmptyHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查询历史版本配置信息。权限要求:admin权限 * @summary 查询历史版本配置信息 * @param {HistoryApiGetHistoryConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHistoryConfig(requestParameters: HistoryApiGetHistoryConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查看历史版本列表。 * @summary 查看历史版本列表 * @param {HistoryApiListHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHistory(requestParameters: HistoryApiListHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于设置历史版本配置信息。权限要求:admin权限。多次调用接口会覆盖之前设置,以最后一次调用为准。更新时,可以设置部分字段;未传入字段,其值保持不变。配置设置生效可能有 1 分钟左右延迟。 * @summary 设置历史版本配置信息 * @param {HistoryApiSetHistoryConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryConfig(requestParameters: HistoryApiSetHistoryConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于设置历史版本为最新版本。权限要求:admin权限、space_admin权限或set_history_latest权限 * @summary 设置历史版本为最新版本 * @param {HistoryApiSetHistoryLatestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryLatest(requestParameters: HistoryApiSetHistoryLatestRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteHistory operation in HistoryApi. */ export interface HistoryApiDeleteHistoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; readonly requestBody: Array; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for emptyHistory operation in HistoryApi. */ export interface HistoryApiEmptyHistoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for getHistoryConfig operation in HistoryApi. */ export interface HistoryApiGetHistoryConfigRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for listHistory operation in HistoryApi. */ export interface HistoryApiListHistoryRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径,对于多级目录,使用斜杠(/)分隔,例如 foo/bar.txt */ readonly filePath: string; /** * 用于顺序列出分页的标识 */ readonly marker?: string; /** * 用于顺序列出分页时本地列出的项目数限制,默认为 20;若不指定任何翻页参数,默认采用(marker,limit)参数翻页;若与(page,page_size)参数同时使用,默认采用(page,page_size)参数翻页 */ readonly limit?: number; /** * 分页码,默认第一页 */ readonly page?: number; /** * 分页大小,默认 20;若与(marker,limit)参数同时使用,默认采用(page,page_size)参数翻页 */ readonly pageSize?: number; /** * 排序字段,按文件 id 排序为 id,按创建时间排序为 creationTime,默认为 id,最新版本排序始终在首位 */ readonly orderBy?: ListHistoryOrderByEnum; /** * 排序方式,升序为 asc,降序为 desc,默认为 desc */ readonly orderByType?: ListHistoryOrderByTypeEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for setHistoryConfig operation in HistoryApi. */ export interface HistoryApiSetHistoryConfigRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; readonly setHistoryConfigRequest: SetHistoryConfigRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for setHistoryLatest operation in HistoryApi. */ export interface HistoryApiSetHistoryLatestRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 历史版本 ID */ readonly historyId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * HistoryApi - object-oriented interface */ export declare class HistoryApi extends BaseAPI { /** * 用于删除特定历史版本。权限要求:delete_history权限、admin权限或space_admin权限 * @summary 删除历史版本 * @param {HistoryApiDeleteHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteHistory(requestParameters: HistoryApiDeleteHistoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于清空整个library的历史版本,请求此接口时,需要先关闭历史版本。注意:此接口会清空整个library全部文件的历史版本,相应的空间会释放,不可找回数据,请谨慎操作!此接口有频控限制,每分钟最多调用1次,请勿频繁调用。权限要求:admin权限 * @summary 清空历史版本 * @param {HistoryApiEmptyHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ emptyHistory(requestParameters: HistoryApiEmptyHistoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查询历史版本配置信息。权限要求:admin权限 * @summary 查询历史版本配置信息 * @param {HistoryApiGetHistoryConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHistoryConfig(requestParameters: HistoryApiGetHistoryConfigRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查看历史版本列表。 * @summary 查看历史版本列表 * @param {HistoryApiListHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHistory(requestParameters: HistoryApiListHistoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于设置历史版本配置信息。权限要求:admin权限。多次调用接口会覆盖之前设置,以最后一次调用为准。更新时,可以设置部分字段;未传入字段,其值保持不变。配置设置生效可能有 1 分钟左右延迟。 * @summary 设置历史版本配置信息 * @param {HistoryApiSetHistoryConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryConfig(requestParameters: HistoryApiSetHistoryConfigRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于设置历史版本为最新版本。权限要求:admin权限、space_admin权限或set_history_latest权限 * @summary 设置历史版本为最新版本 * @param {HistoryApiSetHistoryLatestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setHistoryLatest(requestParameters: HistoryApiSetHistoryLatestRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const ListHistoryOrderByEnum: { readonly Id: "id"; readonly CreationTime: "creationTime"; }; export type ListHistoryOrderByEnum = typeof ListHistoryOrderByEnum[keyof typeof ListHistoryOrderByEnum]; export declare const ListHistoryOrderByTypeEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type ListHistoryOrderByTypeEnum = typeof ListHistoryOrderByTypeEnum[keyof typeof ListHistoryOrderByTypeEnum];