Function LyricsApiFactory

LyricsApi - factory interface

Export

LyricsApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    deleteLyrics(
        requestParameters: LyricsApiDeleteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    downloadRemoteLyrics(
        requestParameters: LyricsApiDownloadRemoteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
    getLyrics(
        requestParameters: LyricsApiGetLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
    getRemoteLyrics(
        requestParameters: LyricsApiGetRemoteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
    searchRemoteLyrics(
        requestParameters: LyricsApiSearchRemoteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RemoteLyricInfoDto[]>;
    uploadLyrics(
        requestParameters: LyricsApiUploadLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    deleteLyrics(
        requestParameters: LyricsApiDeleteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    downloadRemoteLyrics(
        requestParameters: LyricsApiDownloadRemoteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
    getLyrics(
        requestParameters: LyricsApiGetLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
    getRemoteLyrics(
        requestParameters: LyricsApiGetRemoteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
    searchRemoteLyrics(
        requestParameters: LyricsApiSearchRemoteLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RemoteLyricInfoDto[]>;
    uploadLyrics(
        requestParameters: LyricsApiUploadLyricsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>;
}
- deleteLyrics:function
  - deleteLyrics(
    requestParameters: LyricsApiDeleteLyricsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LyricsApiDeleteLyricsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/lyrics-api.ts:380
- downloadRemoteLyrics:function
  - downloadRemoteLyrics(
    requestParameters: LyricsApiDownloadRemoteLyricsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>
  - Parameters
    - requestParameters: LyricsApiDownloadRemoteLyricsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<LyricDto>
    Throws
    - Defined in generated-client/api/lyrics-api.ts:390
- getLyrics:function
  - getLyrics(
    requestParameters: LyricsApiGetLyricsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>
  - Parameters
    - requestParameters: LyricsApiGetLyricsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<LyricDto>
    Throws
    - Defined in generated-client/api/lyrics-api.ts:400
- getRemoteLyrics:function
  - getRemoteLyrics(
    requestParameters: LyricsApiGetRemoteLyricsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>
  - Parameters
    - requestParameters: LyricsApiGetRemoteLyricsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<LyricDto>
    Throws
    - Defined in generated-client/api/lyrics-api.ts:410
- searchRemoteLyrics:function
  - searchRemoteLyrics(
    requestParameters: LyricsApiSearchRemoteLyricsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<RemoteLyricInfoDto[]>
  - Parameters
    - requestParameters: LyricsApiSearchRemoteLyricsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<RemoteLyricInfoDto[]>
    Throws
    - Defined in generated-client/api/lyrics-api.ts:420
- uploadLyrics:function
  - uploadLyrics(
    requestParameters: LyricsApiUploadLyricsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<LyricDto>
  - Parameters
    - requestParameters: LyricsApiUploadLyricsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<LyricDto>
    Throws
    - Defined in generated-client/api/lyrics-api.ts:430
- Defined in generated-client/api/lyrics-api.ts:370

Function LyricsApiFactory

Export

Parameters

deleteLyrics:function

Parameters

Returns AxiosPromise<void>

Throws

downloadRemoteLyrics:function

Parameters

Returns AxiosPromise<LyricDto>

Throws

getLyrics:function

Parameters

Returns AxiosPromise<LyricDto>

Throws

getRemoteLyrics:function

Parameters

Returns AxiosPromise<LyricDto>

Throws

searchRemoteLyrics:function

Parameters

Returns AxiosPromise<RemoteLyricInfoDto[]>

Throws

uploadLyrics:function

Parameters

Returns AxiosPromise<LyricDto>

Throws

Settings