Class LyricsApi

LyricsApi - object-oriented interface

Export

LyricsApi

Hierarchy

BaseAPI
- LyricsApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteLyrics downloadRemoteLyrics getLyrics getRemoteLyrics searchRemoteLyrics uploadLyrics

Constructors

constructor

new LyricsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): LyricsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LyricsApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteLyrics

deleteLyrics(
requestParameters: LyricsApiDeleteLyricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: LyricsApiDeleteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:556

downloadRemoteLyrics

downloadRemoteLyrics(
requestParameters: LyricsApiDownloadRemoteLyricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LyricDto>>
Parameters
- requestParameters: LyricsApiDownloadRemoteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto>>
Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:568

getLyrics

getLyrics(
requestParameters: LyricsApiGetLyricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LyricDto>>
Parameters
- requestParameters: LyricsApiGetLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto>>
Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:580

getRemoteLyrics

getRemoteLyrics(
requestParameters: LyricsApiGetRemoteLyricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LyricDto>>
Parameters
- requestParameters: LyricsApiGetRemoteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto>>
Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:592

searchRemoteLyrics

searchRemoteLyrics(
requestParameters: LyricsApiSearchRemoteLyricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteLyricInfoDto[]>>
Parameters
- requestParameters: LyricsApiSearchRemoteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteLyricInfoDto[]>>
Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:604

uploadLyrics

uploadLyrics(
requestParameters: LyricsApiUploadLyricsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<LyricDto>>
Parameters
- requestParameters: LyricsApiUploadLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto>>
Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:616