Class ItemLookupApi

ItemLookupApi - object-oriented interface

Hierarchy

BaseAPI
- ItemLookupApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

applySearchCriteria

applySearchCriteria(
requestParameters: ItemLookupApiApplySearchCriteriaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: ItemLookupApiApplySearchCriteriaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:885

getBookRemoteSearchResults

getBookRemoteSearchResults(
requestParameters: ItemLookupApiGetBookRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetBookRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:896

getBoxSetRemoteSearchResults

getBoxSetRemoteSearchResults(
requestParameters: ItemLookupApiGetBoxSetRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetBoxSetRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:907

getExternalIdInfos

getExternalIdInfos(
requestParameters: ItemLookupApiGetExternalIdInfosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ExternalIdInfo[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetExternalIdInfosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ExternalIdInfo[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:918

getMovieRemoteSearchResults

getMovieRemoteSearchResults(
requestParameters: ItemLookupApiGetMovieRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetMovieRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:929

getMusicAlbumRemoteSearchResults

getMusicAlbumRemoteSearchResults(
requestParameters: ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:940

getMusicArtistRemoteSearchResults

getMusicArtistRemoteSearchResults(
requestParameters: ItemLookupApiGetMusicArtistRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetMusicArtistRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:951

getMusicVideoRemoteSearchResults

getMusicVideoRemoteSearchResults(
requestParameters: ItemLookupApiGetMusicVideoRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetMusicVideoRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:962

getPersonRemoteSearchResults

getPersonRemoteSearchResults(
requestParameters: ItemLookupApiGetPersonRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetPersonRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:973

getSeriesRemoteSearchResults

getSeriesRemoteSearchResults(
requestParameters: ItemLookupApiGetSeriesRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetSeriesRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:984

getTrailerRemoteSearchResults

getTrailerRemoteSearchResults(
requestParameters: ItemLookupApiGetTrailerRemoteSearchResultsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteSearchResult[], any, {}>>
Parameters
- requestParameters: ItemLookupApiGetTrailerRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws
- Defined in generated-client/api/item-lookup-api.ts:995

Class ItemLookupApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ItemLookupApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

applySearchCriteria

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

getBookRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getBoxSetRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getExternalIdInfos

Parameters

Returns Promise<AxiosResponse<ExternalIdInfo[], any, {}>>

Throws

getMovieRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getMusicAlbumRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getMusicArtistRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getMusicVideoRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getPersonRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getSeriesRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

getTrailerRemoteSearchResults

Parameters

Returns Promise<AxiosResponse<RemoteSearchResult[], any, {}>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration