ItemLookupApi - axios parameter creator

  • Parameters

    Returns {
        applySearchCriteria: ((itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getBookRemoteSearchResults: ((bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getBoxSetRemoteSearchResults: ((boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getExternalIdInfos: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getMovieRemoteSearchResults: ((movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getMusicAlbumRemoteSearchResults: ((albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getMusicArtistRemoteSearchResults: ((artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getMusicVideoRemoteSearchResults: ((musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPersonRemoteSearchResults: ((personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSeriesRemoteSearchResults: ((seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTrailerRemoteSearchResults: ((trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • applySearchCriteria: ((itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Applies search criteria to an item and refreshes metadata.

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

          • itemId: string

            Item id.

          • remoteSearchResult: RemoteSearchResult

            The remote search result.

          • OptionalreplaceAllImages: boolean

            Optional. Whether or not to replace all images. Default: True.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getBookRemoteSearchResults: ((bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get book remote search.

        • (bookInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getBoxSetRemoteSearchResults: ((boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get box set remote search.

        • (boxSetInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Get the item's external id info.

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

          • itemId: string

            Item id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getMovieRemoteSearchResults: ((movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get movie remote search.

        • (movieInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getMusicAlbumRemoteSearchResults: ((albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get music album remote search.

        • (albumInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getMusicArtistRemoteSearchResults: ((artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get music artist remote search.

        • (artistInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getMusicVideoRemoteSearchResults: ((musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get music video remote search.

        • (musicVideoInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPersonRemoteSearchResults: ((personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get person remote search.

        • (personLookupInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          Returns Promise<RequestArgs>

    • getSeriesRemoteSearchResults: ((seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get series remote search.

        • (seriesInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getTrailerRemoteSearchResults: ((trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get trailer remote search.

        • (trailerInfoRemoteSearchQuery, options?): Promise<RequestArgs>
        • Parameters

          • trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery

            Remote search query.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>