ItemLookupApi - functional programming interface

  • Parameters

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

    • applySearchCriteria:function
      • 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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    • getBookRemoteSearchResults:function
    • getBoxSetRemoteSearchResults:function
    • getExternalIdInfos:function
      • Parameters

        • itemId: string

          Item id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ExternalIdInfo[]>,
        >

    • getMovieRemoteSearchResults:function
    • getMusicAlbumRemoteSearchResults:function
    • getMusicArtistRemoteSearchResults:function
    • getMusicVideoRemoteSearchResults:function
    • getPersonRemoteSearchResults:function
    • getSeriesRemoteSearchResults:function
    • getTrailerRemoteSearchResults:function