Class ItemLookupApi

ItemLookupApi - object-oriented interface

Export

ItemLookupApi

Hierarchy

BaseAPI
- ItemLookupApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

applySearchCriteria

applySearchCriteria(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ItemLookupApiApplySearchCriteriaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Applies search criteria to an item and refreshes metadata.

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:950

getBookRemoteSearchResults

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

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

getBoxSetRemoteSearchResults

getBoxSetRemoteSearchResults(requestParameters, options?): Promise<AxiosResponse<RemoteSearchResult[], any>>
Parameters
- requestParameters: ItemLookupApiGetBoxSetRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any>>
Summary
Get box set remote search.

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:974

getExternalIdInfos

getExternalIdInfos(requestParameters, options?): Promise<AxiosResponse<ExternalIdInfo[], any>>
Parameters
- requestParameters: ItemLookupApiGetExternalIdInfosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ExternalIdInfo[], any>>
Summary
Get the item's external id info.

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:986

getMovieRemoteSearchResults

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

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:998

getMusicAlbumRemoteSearchResults

getMusicAlbumRemoteSearchResults(requestParameters, options?): Promise<AxiosResponse<RemoteSearchResult[], any>>
Parameters
- requestParameters: ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any>>
Summary
Get music album remote search.

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:1010

getMusicArtistRemoteSearchResults

getMusicArtistRemoteSearchResults(requestParameters, options?): Promise<AxiosResponse<RemoteSearchResult[], any>>
Parameters
- requestParameters: ItemLookupApiGetMusicArtistRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any>>
Summary
Get music artist remote search.

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:1022

getMusicVideoRemoteSearchResults

getMusicVideoRemoteSearchResults(requestParameters, options?): Promise<AxiosResponse<RemoteSearchResult[], any>>
Parameters
- requestParameters: ItemLookupApiGetMusicVideoRemoteSearchResultsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteSearchResult[], any>>
Summary
Get music video remote search.

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:1034

getPersonRemoteSearchResults

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

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:1046

getSeriesRemoteSearchResults

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

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:1058

getTrailerRemoteSearchResults

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

Throws
Memberof
ItemLookupApi
- Defined in generated-client/api/item-lookup-api.ts:1070

Class ItemLookupApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ItemLookupApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

applySearchCriteria

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

getBookRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getBoxSetRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getExternalIdInfos

Parameters

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

Summary

Throws

Memberof

getMovieRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getMusicAlbumRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getMusicArtistRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getMusicVideoRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getPersonRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getSeriesRemoteSearchResults

Parameters

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

Summary

Throws

Memberof

getTrailerRemoteSearchResults

Parameters

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

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration