/** * 腾讯云智能媒资托管服务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 { CreateToken200Response } from '../models'; /** * TokenApi - axios parameter creator */ export declare const TokenApiAxiosParamCreator: (configuration?: Configuration) => { /** * 用于生成调用智能媒资托管服务的访问令牌(Access Token)。 * @summary 生成访问令牌 * @param {string} libraryId 媒体库ID,在媒体托管控制台创建媒体库后获取。 * @param {string} librarySecret 媒体库密钥,在媒体托管控制台创建媒体库后获取。 * @param {string} [spaceId] 空间ID,可同时指定多个空间ID,使用英文逗号(,)分隔。 * @param {string} [userId] 用户身份识别,由业务后台自行控制。 * @param {string} [clientId] 客户端识别,由业务后台自行控制。 * @param {string} [sessionId] SessionId,由业务后台自行控制。 * @param {number} [period] 令牌有效时长及每次使用令牌后自动续期的有效时长,单位为秒。 * @param {CreateTokenGrantEnum} [grant] 授予的权限,如为空则只授予读取权限。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createToken: (libraryId: string, librarySecret: string, spaceId?: string, userId?: string, clientId?: string, sessionId?: string, period?: number, grant?: CreateTokenGrantEnum, options?: RawAxiosRequestConfig) => Promise; /** * 用于删除指定的访问令牌(Access Token)。删除指定访问令牌无需校验媒体库密钥,故可在客户端调用该接口。 * @summary 删除访问令牌 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} accessToken 访问令牌 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken: (libraryId: string, accessToken: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于删除特定用户的所有访问令牌(Access Token)。调用该接口需要用到媒体库密钥,所以必须在后端调用该接口以保证密钥安全;必须指定 UserId 参数,因此在创建访问令牌时,如果后续计划主动删除对应的访问令牌,则在创建时也需要指定 UserId; * @summary 删除特定用户的所有访问令牌 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} librarySecret 媒体库密钥 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [clientId] 客户端识别,多个 ClientId 用英文逗号分隔,一次最多不超过 100 个 * @param {string} [sessionId] 会话识别,多个 SessionId 用英文逗号分隔,一次最多不超过 100 个 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserTokens: (libraryId: string, librarySecret: string, userId?: string, clientId?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于续期访问令牌(Access Token)。续期时不支持指定新的有效时长,仅按照获取令牌时指定的有效时长续期。 * @summary 续期访问令牌 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} accessToken 访问令牌 * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewToken: (libraryId: string, accessToken: string, options?: RawAxiosRequestConfig) => Promise; }; /** * TokenApi - functional programming interface */ export declare const TokenApiFp: (configuration?: Configuration) => { /** * 用于生成调用智能媒资托管服务的访问令牌(Access Token)。 * @summary 生成访问令牌 * @param {string} libraryId 媒体库ID,在媒体托管控制台创建媒体库后获取。 * @param {string} librarySecret 媒体库密钥,在媒体托管控制台创建媒体库后获取。 * @param {string} [spaceId] 空间ID,可同时指定多个空间ID,使用英文逗号(,)分隔。 * @param {string} [userId] 用户身份识别,由业务后台自行控制。 * @param {string} [clientId] 客户端识别,由业务后台自行控制。 * @param {string} [sessionId] SessionId,由业务后台自行控制。 * @param {number} [period] 令牌有效时长及每次使用令牌后自动续期的有效时长,单位为秒。 * @param {CreateTokenGrantEnum} [grant] 授予的权限,如为空则只授予读取权限。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createToken(libraryId: string, librarySecret: string, spaceId?: string, userId?: string, clientId?: string, sessionId?: string, period?: number, grant?: CreateTokenGrantEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于删除指定的访问令牌(Access Token)。删除指定访问令牌无需校验媒体库密钥,故可在客户端调用该接口。 * @summary 删除访问令牌 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} accessToken 访问令牌 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken(libraryId: string, accessToken: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于删除特定用户的所有访问令牌(Access Token)。调用该接口需要用到媒体库密钥,所以必须在后端调用该接口以保证密钥安全;必须指定 UserId 参数,因此在创建访问令牌时,如果后续计划主动删除对应的访问令牌,则在创建时也需要指定 UserId; * @summary 删除特定用户的所有访问令牌 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} librarySecret 媒体库密钥 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [clientId] 客户端识别,多个 ClientId 用英文逗号分隔,一次最多不超过 100 个 * @param {string} [sessionId] 会话识别,多个 SessionId 用英文逗号分隔,一次最多不超过 100 个 * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserTokens(libraryId: string, librarySecret: string, userId?: string, clientId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于续期访问令牌(Access Token)。续期时不支持指定新的有效时长,仅按照获取令牌时指定的有效时长续期。 * @summary 续期访问令牌 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} accessToken 访问令牌 * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewToken(libraryId: string, accessToken: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TokenApi - factory interface */ export declare const TokenApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 用于生成调用智能媒资托管服务的访问令牌(Access Token)。 * @summary 生成访问令牌 * @param {TokenApiCreateTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createToken(requestParameters: TokenApiCreateTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于删除指定的访问令牌(Access Token)。删除指定访问令牌无需校验媒体库密钥,故可在客户端调用该接口。 * @summary 删除访问令牌 * @param {TokenApiDeleteTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken(requestParameters: TokenApiDeleteTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于删除特定用户的所有访问令牌(Access Token)。调用该接口需要用到媒体库密钥,所以必须在后端调用该接口以保证密钥安全;必须指定 UserId 参数,因此在创建访问令牌时,如果后续计划主动删除对应的访问令牌,则在创建时也需要指定 UserId; * @summary 删除特定用户的所有访问令牌 * @param {TokenApiDeleteUserTokensRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserTokens(requestParameters: TokenApiDeleteUserTokensRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于续期访问令牌(Access Token)。续期时不支持指定新的有效时长,仅按照获取令牌时指定的有效时长续期。 * @summary 续期访问令牌 * @param {TokenApiRenewTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewToken(requestParameters: TokenApiRenewTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createToken operation in TokenApi. */ export interface TokenApiCreateTokenRequest { /** * 媒体库ID,在媒体托管控制台创建媒体库后获取。 */ readonly libraryId: string; /** * 媒体库密钥,在媒体托管控制台创建媒体库后获取。 */ readonly librarySecret: string; /** * 空间ID,可同时指定多个空间ID,使用英文逗号(,)分隔。 */ readonly spaceId?: string; /** * 用户身份识别,由业务后台自行控制。 */ readonly userId?: string; /** * 客户端识别,由业务后台自行控制。 */ readonly clientId?: string; /** * SessionId,由业务后台自行控制。 */ readonly sessionId?: string; /** * 令牌有效时长及每次使用令牌后自动续期的有效时长,单位为秒。 */ readonly period?: number; /** * 授予的权限,如为空则只授予读取权限。 */ readonly grant?: CreateTokenGrantEnum; } /** * Request parameters for deleteToken operation in TokenApi. */ export interface TokenApiDeleteTokenRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌 */ readonly accessToken: string; } /** * Request parameters for deleteUserTokens operation in TokenApi. */ export interface TokenApiDeleteUserTokensRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 媒体库密钥 */ readonly librarySecret: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 客户端识别,多个 ClientId 用英文逗号分隔,一次最多不超过 100 个 */ readonly clientId?: string; /** * 会话识别,多个 SessionId 用英文逗号分隔,一次最多不超过 100 个 */ readonly sessionId?: string; } /** * Request parameters for renewToken operation in TokenApi. */ export interface TokenApiRenewTokenRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌 */ readonly accessToken: string; } /** * TokenApi - object-oriented interface */ export declare class TokenApi extends BaseAPI { /** * 用于生成调用智能媒资托管服务的访问令牌(Access Token)。 * @summary 生成访问令牌 * @param {TokenApiCreateTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createToken(requestParameters: TokenApiCreateTokenRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于删除指定的访问令牌(Access Token)。删除指定访问令牌无需校验媒体库密钥,故可在客户端调用该接口。 * @summary 删除访问令牌 * @param {TokenApiDeleteTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken(requestParameters: TokenApiDeleteTokenRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于删除特定用户的所有访问令牌(Access Token)。调用该接口需要用到媒体库密钥,所以必须在后端调用该接口以保证密钥安全;必须指定 UserId 参数,因此在创建访问令牌时,如果后续计划主动删除对应的访问令牌,则在创建时也需要指定 UserId; * @summary 删除特定用户的所有访问令牌 * @param {TokenApiDeleteUserTokensRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserTokens(requestParameters: TokenApiDeleteUserTokensRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于续期访问令牌(Access Token)。续期时不支持指定新的有效时长,仅按照获取令牌时指定的有效时长续期。 * @summary 续期访问令牌 * @param {TokenApiRenewTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewToken(requestParameters: TokenApiRenewTokenRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const CreateTokenGrantEnum: { readonly Admin: "admin"; readonly CreateSpace: "create_space"; readonly DeleteSpace: "delete_space"; readonly SpaceAdmin: "space_admin"; readonly CreateDirectory: "create_directory"; readonly DeleteDirectory: "delete_directory"; readonly DeleteDirectoryPermanent: "delete_directory_permanent"; readonly MoveDirectory: "move_directory"; readonly CopyDirectory: "copy_directory"; readonly UploadFile: "upload_file"; readonly UploadFileForce: "upload_file_force"; readonly BeginUpload: "begin_upload"; readonly BeginUploadForce: "begin_upload_force"; readonly ConfirmUpload: "confirm_upload"; readonly CreateSymlink: "create_symlink"; readonly CreateSymlinkForce: "create_symlink_force"; readonly DeleteFile: "delete_file"; readonly DeleteFilePermanent: "delete_file_permanent"; readonly MoveFile: "move_file"; readonly MoveFileForce: "move_file_force"; readonly CopyFile: "copy_file"; readonly CopyFileForce: "copy_file_force"; readonly DeleteRecycled: "delete_recycled"; readonly RestoreRecycled: "restore_recycled"; }; export type CreateTokenGrantEnum = typeof CreateTokenGrantEnum[keyof typeof CreateTokenGrantEnum];