Function LyricsApiAxiosParamCreator

LyricsApi - axios parameter creator

Export

  • LyricsApiAxiosParamCreator(configuration?): {
        deleteLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        downloadRemoteLyrics: ((itemId: string, lyricId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteLyrics: ((lyricId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        searchRemoteLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uploadLyrics: ((itemId: string, fileName: string, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        deleteLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        downloadRemoteLyrics: ((itemId: string, lyricId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteLyrics: ((lyricId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        searchRemoteLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uploadLyrics: ((itemId: string, fileName: string, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • deleteLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Deletes an external lyric file.

      Throws

        • (itemId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • downloadRemoteLyrics: ((itemId: string, lyricId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Downloads a remote lyric.

      Throws

        • (itemId, lyricId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item id.

          • lyricId: string

            The lyric id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets an item's lyrics.

      Throws

        • (itemId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            Item id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getRemoteLyrics: ((lyricId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the remote lyrics.

      Throws

        • (lyricId, options?): Promise<RequestArgs>

        • Parameters

          • lyricId: string

            The remote provider item id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • searchRemoteLyrics: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Search remote lyrics.

      Throws

        • (itemId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • uploadLyrics: ((itemId: string, fileName: string, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Upload an external lyric file.

      Throws

        • (itemId, fileName, body?, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item the lyric belongs to.

          • fileName: string

            Name of the file being uploaded.

          • Optionalbody: File
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility