Package com.amilesend.tvdb.client.api

Class SearchApi

java.lang.Object

com.amilesend.tvdb.client.api.SearchApi

public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SearchApi()
SearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
InlineResponse20039	getSearchResults(String query, String q, String type, BigDecimal year, String company, String country, String director, String language, String primaryType, String network, String remoteId, BigDecimal offset, BigDecimal limit)	Our search index includes series, movies, people, and companies.
okhttp3.Call	getSearchResultsAsync(String query, String q, String type, BigDecimal year, String company, String country, String director, String language, String primaryType, String network, String remoteId, BigDecimal offset, BigDecimal limit, ApiCallback<InlineResponse20039> callback)	(asynchronously) Our search index includes series, movies, people, and companies.
InlineResponse20040	getSearchResultsByRemoteId(String remoteId)	Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.
okhttp3.Call	getSearchResultsByRemoteIdAsync(String remoteId, ApiCallback<InlineResponse20040> callback)	(asynchronously) Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.
okhttp3.Call	getSearchResultsByRemoteIdCall(String remoteId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getSearchResultsByRemoteId
ApiResponse<InlineResponse20040>	getSearchResultsByRemoteIdWithHttpInfo(String remoteId)	Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.
okhttp3.Call	getSearchResultsCall(String query, String q, String type, BigDecimal year, String company, String country, String director, String language, String primaryType, String network, String remoteId, BigDecimal offset, BigDecimal limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getSearchResults
ApiResponse<InlineResponse20039>	getSearchResultsWithHttpInfo(String query, String q, String type, BigDecimal year, String company, String country, String director, String language, String primaryType, String network, String remoteId, BigDecimal offset, BigDecimal limit)	Our search index includes series, movies, people, and companies.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchApi

public SearchApi()

SearchApi

public SearchApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSearchResultsCall

public okhttp3.Call getSearchResultsCall(String query,
 String q,
 String type,
 BigDecimal year,
 String company,
 String country,
 String director,
 String language,
 String primaryType,
 String network,
 String remoteId,
 BigDecimal offset,
 BigDecimal limit,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                  throws ApiException

Build call for getSearchResults

Parameters:

query - The primary search string, which can include the main title for a record including all translations and aliases. (optional)

q - Alias of the \"query\" parameter. Recommend using query instead as this field will eventually be deprecated. (optional)

type - Restrict results to a specific entity type. Can be movie, series, person, or company. (optional)

year - Restrict results to a specific year. Currently only used for series and movies. (optional)

company - Restrict results to a specific company (original network, production company, studio, etc). As an example, \"The Walking Dead\" would have companies of \"AMC\", \"AMC+\", and \"Disney+\". (optional)

country - Restrict results to a specific country of origin. Should contain a 3 character country code. Currently only used for series and movies. (optional)

director - Restrict results to a specific director. Generally only used for movies. Should include the full name of the director, such as \"Steven Spielberg\". (optional)

language - Restrict results to a specific primary language. Should include the 3 character language code. Currently only used for series and movies. (optional)

primaryType - Restrict results to a specific type of company. Should include the full name of the type of company, such as \"Production Company\". Only used for companies. (optional)

network - Restrict results to a specific network. Used for TV and TV movies, and functions the same as the company parameter with more specificity. (optional)

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (optional)

offset - Offset results. (optional)

limit - Limit results. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSearchResults

public InlineResponse20039 getSearchResults(String query,
 String q,
 String type,
 BigDecimal year,
 String company,
 String country,
 String director,
 String language,
 String primaryType,
 String network,
 String remoteId,
 BigDecimal offset,
 BigDecimal limit)
                                     throws ApiException

Our search index includes series, movies, people, and companies. Search is limited to 5k results max.

Parameters:

query - The primary search string, which can include the main title for a record including all translations and aliases. (optional)

q - Alias of the \"query\" parameter. Recommend using query instead as this field will eventually be deprecated. (optional)

type - Restrict results to a specific entity type. Can be movie, series, person, or company. (optional)

year - Restrict results to a specific year. Currently only used for series and movies. (optional)

company - Restrict results to a specific company (original network, production company, studio, etc). As an example, \"The Walking Dead\" would have companies of \"AMC\", \"AMC+\", and \"Disney+\". (optional)

country - Restrict results to a specific country of origin. Should contain a 3 character country code. Currently only used for series and movies. (optional)

director - Restrict results to a specific director. Generally only used for movies. Should include the full name of the director, such as \"Steven Spielberg\". (optional)

language - Restrict results to a specific primary language. Should include the 3 character language code. Currently only used for series and movies. (optional)

primaryType - Restrict results to a specific type of company. Should include the full name of the type of company, such as \"Production Company\". Only used for companies. (optional)

network - Restrict results to a specific network. Used for TV and TV movies, and functions the same as the company parameter with more specificity. (optional)

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (optional)

offset - Offset results. (optional)

limit - Limit results. (optional)

Returns:

InlineResponse20039

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSearchResultsWithHttpInfo

public ApiResponse<InlineResponse20039> getSearchResultsWithHttpInfo(String query,
 String q,
 String type,
 BigDecimal year,
 String company,
 String country,
 String director,
 String language,
 String primaryType,
 String network,
 String remoteId,
 BigDecimal offset,
 BigDecimal limit)
                                                              throws ApiException

Our search index includes series, movies, people, and companies. Search is limited to 5k results max.

Parameters:

query - The primary search string, which can include the main title for a record including all translations and aliases. (optional)

q - Alias of the \"query\" parameter. Recommend using query instead as this field will eventually be deprecated. (optional)

type - Restrict results to a specific entity type. Can be movie, series, person, or company. (optional)

year - Restrict results to a specific year. Currently only used for series and movies. (optional)

company - Restrict results to a specific company (original network, production company, studio, etc). As an example, \"The Walking Dead\" would have companies of \"AMC\", \"AMC+\", and \"Disney+\". (optional)

country - Restrict results to a specific country of origin. Should contain a 3 character country code. Currently only used for series and movies. (optional)

director - Restrict results to a specific director. Generally only used for movies. Should include the full name of the director, such as \"Steven Spielberg\". (optional)

language - Restrict results to a specific primary language. Should include the 3 character language code. Currently only used for series and movies. (optional)

primaryType - Restrict results to a specific type of company. Should include the full name of the type of company, such as \"Production Company\". Only used for companies. (optional)

network - Restrict results to a specific network. Used for TV and TV movies, and functions the same as the company parameter with more specificity. (optional)

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (optional)

offset - Offset results. (optional)

limit - Limit results. (optional)

Returns:

ApiResponse<InlineResponse20039>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSearchResultsAsync

public okhttp3.Call getSearchResultsAsync(String query,
 String q,
 String type,
 BigDecimal year,
 String company,
 String country,
 String director,
 String language,
 String primaryType,
 String network,
 String remoteId,
 BigDecimal offset,
 BigDecimal limit,
 ApiCallback<InlineResponse20039> callback)
                                   throws ApiException

(asynchronously) Our search index includes series, movies, people, and companies. Search is limited to 5k results max.

Parameters:

query - The primary search string, which can include the main title for a record including all translations and aliases. (optional)

q - Alias of the \"query\" parameter. Recommend using query instead as this field will eventually be deprecated. (optional)

type - Restrict results to a specific entity type. Can be movie, series, person, or company. (optional)

year - Restrict results to a specific year. Currently only used for series and movies. (optional)

company - Restrict results to a specific company (original network, production company, studio, etc). As an example, \"The Walking Dead\" would have companies of \"AMC\", \"AMC+\", and \"Disney+\". (optional)

country - Restrict results to a specific country of origin. Should contain a 3 character country code. Currently only used for series and movies. (optional)

director - Restrict results to a specific director. Generally only used for movies. Should include the full name of the director, such as \"Steven Spielberg\". (optional)

language - Restrict results to a specific primary language. Should include the 3 character language code. Currently only used for series and movies. (optional)

primaryType - Restrict results to a specific type of company. Should include the full name of the type of company, such as \"Production Company\". Only used for companies. (optional)

network - Restrict results to a specific network. Used for TV and TV movies, and functions the same as the company parameter with more specificity. (optional)

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (optional)

offset - Offset results. (optional)

limit - Limit results. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getSearchResultsByRemoteIdCall

public okhttp3.Call getSearchResultsByRemoteIdCall(String remoteId,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getSearchResultsByRemoteId

Parameters:

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSearchResultsByRemoteId

public InlineResponse20040 getSearchResultsByRemoteId(String remoteId)
                                               throws ApiException

Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.

Parameters:

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (required)

Returns:

InlineResponse20040

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSearchResultsByRemoteIdWithHttpInfo

public ApiResponse<InlineResponse20040> getSearchResultsByRemoteIdWithHttpInfo(String remoteId)
                                                                        throws ApiException

Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.

Parameters:

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (required)

Returns:

ApiResponse<InlineResponse20040>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSearchResultsByRemoteIdAsync

public okhttp3.Call getSearchResultsByRemoteIdAsync(String remoteId,
 ApiCallback<InlineResponse20040> callback)
                                             throws ApiException

(asynchronously) Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.

Parameters:

remoteId - Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object