/** * 腾讯云智能媒资托管服务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 { CreateFavorite200Response } from '../models'; import type { CreateFavoriteRequest } from '../models'; import type { ListFavorite200Response } from '../models'; /** * FavoriteApi - axios parameter creator */ export declare const FavoriteApiAxiosParamCreator: (configuration?: Configuration) => { /** * 收藏文件目录。需要提供路径或inode,二者二选一;如果同时提供,以inode为准。 * @summary 收藏指定空间文件 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {CreateFavoriteRequest} createFavoriteRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFavorite: (libraryId: string, spaceId: string, createFavoriteRequest: CreateFavoriteRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 取消收藏。根据路径或inode取消收藏,二者二选一;如果同时提供,以inode为准。 * @summary 取消收藏指定空间文件 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {DeleteFavoriteCancelEnum} cancel 取消收藏标志,传递该参数表示执行取消收藏操作 * @param {CreateFavoriteRequest} deleteFavoriteRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFavorite: (libraryId: string, spaceId: string, cancel: DeleteFavoriteCancelEnum, deleteFavoriteRequest: CreateFavoriteRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 查看指定空间收藏列表,支持分页和排序 * @summary 查看指定空间收藏列表 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [marker] 用于顺序列出分页的标识,可选参数 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,默认为20,可选参数 * @param {number} [page] 分页码,默认第一页,可选参数,不能与marker和limit参数同时使用 * @param {number} [pageSize] 分页大小,默认20,可选参数,不能与marker和limit参数同时使用 * @param {ListFavoriteOrderByEnum} [orderBy] 排序字段,按收藏时间排序为favoriteTime(默认),目前仅支持按收藏时间排序,可选参数 * @param {ListFavoriteOrderByTypeEnum} [orderByType] 排序方式,升序为asc,降序为desc(默认),可选参数 * @param {boolean} [withPath] 是否返回path,返回为true,不返回为false(默认),可选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFavorite: (libraryId: string, spaceId: string, marker?: string, limit?: number, page?: number, pageSize?: number, orderBy?: ListFavoriteOrderByEnum, orderByType?: ListFavoriteOrderByTypeEnum, withPath?: boolean, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * FavoriteApi - functional programming interface */ export declare const FavoriteApiFp: (configuration?: Configuration) => { /** * 收藏文件目录。需要提供路径或inode,二者二选一;如果同时提供,以inode为准。 * @summary 收藏指定空间文件 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {CreateFavoriteRequest} createFavoriteRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFavorite(libraryId: string, spaceId: string, createFavoriteRequest: CreateFavoriteRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 取消收藏。根据路径或inode取消收藏,二者二选一;如果同时提供,以inode为准。 * @summary 取消收藏指定空间文件 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {DeleteFavoriteCancelEnum} cancel 取消收藏标志,传递该参数表示执行取消收藏操作 * @param {CreateFavoriteRequest} deleteFavoriteRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFavorite(libraryId: string, spaceId: string, cancel: DeleteFavoriteCancelEnum, deleteFavoriteRequest: CreateFavoriteRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 查看指定空间收藏列表,支持分页和排序 * @summary 查看指定空间收藏列表 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [marker] 用于顺序列出分页的标识,可选参数 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,默认为20,可选参数 * @param {number} [page] 分页码,默认第一页,可选参数,不能与marker和limit参数同时使用 * @param {number} [pageSize] 分页大小,默认20,可选参数,不能与marker和limit参数同时使用 * @param {ListFavoriteOrderByEnum} [orderBy] 排序字段,按收藏时间排序为favoriteTime(默认),目前仅支持按收藏时间排序,可选参数 * @param {ListFavoriteOrderByTypeEnum} [orderByType] 排序方式,升序为asc,降序为desc(默认),可选参数 * @param {boolean} [withPath] 是否返回path,返回为true,不返回为false(默认),可选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFavorite(libraryId: string, spaceId: string, marker?: string, limit?: number, page?: number, pageSize?: number, orderBy?: ListFavoriteOrderByEnum, orderByType?: ListFavoriteOrderByTypeEnum, withPath?: boolean, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FavoriteApi - factory interface */ export declare const FavoriteApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 收藏文件目录。需要提供路径或inode,二者二选一;如果同时提供,以inode为准。 * @summary 收藏指定空间文件 * @param {FavoriteApiCreateFavoriteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFavorite(requestParameters: FavoriteApiCreateFavoriteRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 取消收藏。根据路径或inode取消收藏,二者二选一;如果同时提供,以inode为准。 * @summary 取消收藏指定空间文件 * @param {FavoriteApiDeleteFavoriteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFavorite(requestParameters: FavoriteApiDeleteFavoriteRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 查看指定空间收藏列表,支持分页和排序 * @summary 查看指定空间收藏列表 * @param {FavoriteApiListFavoriteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFavorite(requestParameters: FavoriteApiListFavoriteRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createFavorite operation in FavoriteApi. */ export interface FavoriteApiCreateFavoriteRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; readonly createFavoriteRequest: CreateFavoriteRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for deleteFavorite operation in FavoriteApi. */ export interface FavoriteApiDeleteFavoriteRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 取消收藏标志,传递该参数表示执行取消收藏操作 */ readonly cancel: DeleteFavoriteCancelEnum; readonly deleteFavoriteRequest: CreateFavoriteRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for listFavorite operation in FavoriteApi. */ export interface FavoriteApiListFavoriteRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 用于顺序列出分页的标识,可选参数 */ readonly marker?: string; /** * 用于顺序列出分页时本地列出的项目数限制,默认为20,可选参数 */ readonly limit?: number; /** * 分页码,默认第一页,可选参数,不能与marker和limit参数同时使用 */ readonly page?: number; /** * 分页大小,默认20,可选参数,不能与marker和limit参数同时使用 */ readonly pageSize?: number; /** * 排序字段,按收藏时间排序为favoriteTime(默认),目前仅支持按收藏时间排序,可选参数 */ readonly orderBy?: ListFavoriteOrderByEnum; /** * 排序方式,升序为asc,降序为desc(默认),可选参数 */ readonly orderByType?: ListFavoriteOrderByTypeEnum; /** * 是否返回path,返回为true,不返回为false(默认),可选参数 */ readonly withPath?: boolean; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * FavoriteApi - object-oriented interface */ export declare class FavoriteApi extends BaseAPI { /** * 收藏文件目录。需要提供路径或inode,二者二选一;如果同时提供,以inode为准。 * @summary 收藏指定空间文件 * @param {FavoriteApiCreateFavoriteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFavorite(requestParameters: FavoriteApiCreateFavoriteRequest, options?: RawAxiosRequestConfig): Promise>; /** * 取消收藏。根据路径或inode取消收藏,二者二选一;如果同时提供,以inode为准。 * @summary 取消收藏指定空间文件 * @param {FavoriteApiDeleteFavoriteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFavorite(requestParameters: FavoriteApiDeleteFavoriteRequest, options?: RawAxiosRequestConfig): Promise>; /** * 查看指定空间收藏列表,支持分页和排序 * @summary 查看指定空间收藏列表 * @param {FavoriteApiListFavoriteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFavorite(requestParameters: FavoriteApiListFavoriteRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const DeleteFavoriteCancelEnum: { readonly NUMBER_1: 1; }; export type DeleteFavoriteCancelEnum = typeof DeleteFavoriteCancelEnum[keyof typeof DeleteFavoriteCancelEnum]; export declare const ListFavoriteOrderByEnum: { readonly FavoriteTime: "favoriteTime"; }; export type ListFavoriteOrderByEnum = typeof ListFavoriteOrderByEnum[keyof typeof ListFavoriteOrderByEnum]; export declare const ListFavoriteOrderByTypeEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type ListFavoriteOrderByTypeEnum = typeof ListFavoriteOrderByTypeEnum[keyof typeof ListFavoriteOrderByTypeEnum];