Package com.amilesend.tvdb.client.api

Class SeriesApi

java.lang.Object
com.amilesend.tvdb.client.api.SeriesApi
public class SeriesApi extends Object

  • Constructor Details

    • SeriesApi

      public SeriesApi()

    • SeriesApi

      public SeriesApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getAllSeriesCall

      public okhttp3.Call getAllSeriesCall(BigDecimal page, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getAllSeries
      Parameters:
      page - page number (optional)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getAllSeries

      public InlineResponse20045 getAllSeries(BigDecimal page) throws ApiException
      returns list of series base records
      Parameters:
      page - page number (optional)
      Returns:
      InlineResponse20045
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAllSeriesWithHttpInfo

      public ApiResponse<InlineResponse20045> getAllSeriesWithHttpInfo(BigDecimal page) throws ApiException
      returns list of series base records
      Parameters:
      page - page number (optional)
      Returns:
      ApiResponse<InlineResponse20045>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAllSeriesAsync

      public okhttp3.Call getAllSeriesAsync(BigDecimal page, ApiCallback<InlineResponse20045> callback) throws ApiException
      (asynchronously) returns list of series base records
      Parameters:
      page - page number (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

    • getSeriesArtworksCall

      public okhttp3.Call getSeriesArtworksCall(BigDecimal id, String lang, Integer type, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesArtworks
      Parameters:
      id - id (required)
      lang - lang (optional)
      type - type (optional)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesArtworks

      public InlineResponse20047 getSeriesArtworks(BigDecimal id, String lang, Integer type) throws ApiException
      Returns series artworks base on language and type. <br> Note&#58; Artwork type is an id that can be found using **_/artwork/types** endpoint.
      Parameters:
      id - id (required)
      lang - lang (optional)
      type - type (optional)
      Returns:
      InlineResponse20047
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesArtworksWithHttpInfo

      public ApiResponse<InlineResponse20047> getSeriesArtworksWithHttpInfo(BigDecimal id, String lang, Integer type) throws ApiException
      Returns series artworks base on language and type. <br> Note&#58; Artwork type is an id that can be found using **_/artwork/types** endpoint.
      Parameters:
      id - id (required)
      lang - lang (optional)
      type - type (optional)
      Returns:
      ApiResponse<InlineResponse20047>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesArtworksAsync

      public okhttp3.Call getSeriesArtworksAsync(BigDecimal id, String lang, Integer type, ApiCallback<InlineResponse20047> callback) throws ApiException
      (asynchronously) Returns series artworks base on language and type. <br> Note&#58; Artwork type is an id that can be found using **_/artwork/types** endpoint.
      Parameters:
      id - id (required)
      lang - lang (optional)
      type - type (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

    • getSeriesBaseCall

      public okhttp3.Call getSeriesBaseCall(BigDecimal id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesBase
      Parameters:
      id - id (required)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesBase

      public InlineResponse20046 getSeriesBase(BigDecimal id) throws ApiException
      Returns series base record
      Parameters:
      id - id (required)
      Returns:
      InlineResponse20046
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesBaseWithHttpInfo

      public ApiResponse<InlineResponse20046> getSeriesBaseWithHttpInfo(BigDecimal id) throws ApiException
      Returns series base record
      Parameters:
      id - id (required)
      Returns:
      ApiResponse<InlineResponse20046>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesBaseAsync

      public okhttp3.Call getSeriesBaseAsync(BigDecimal id, ApiCallback<InlineResponse20046> callback) throws ApiException
      (asynchronously) Returns series base record
      Parameters:
      id - id (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

    • getSeriesBaseBySlugCall

      public okhttp3.Call getSeriesBaseBySlugCall(String slug, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesBaseBySlug
      Parameters:
      slug - slug (required)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesBaseBySlug

      public InlineResponse20046 getSeriesBaseBySlug(String slug) throws ApiException
      Returns series base record searched by slug
      Parameters:
      slug - slug (required)
      Returns:
      InlineResponse20046
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesBaseBySlugWithHttpInfo

      public ApiResponse<InlineResponse20046> getSeriesBaseBySlugWithHttpInfo(String slug) throws ApiException
      Returns series base record searched by slug
      Parameters:
      slug - slug (required)
      Returns:
      ApiResponse<InlineResponse20046>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesBaseBySlugAsync

      public okhttp3.Call getSeriesBaseBySlugAsync(String slug, ApiCallback<InlineResponse20046> callback) throws ApiException
      (asynchronously) Returns series base record searched by slug
      Parameters:
      slug - slug (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

    • getSeriesEpisodesCall

      public okhttp3.Call getSeriesEpisodesCall(Integer page, BigDecimal id, String seasonType, Integer season, Integer episodeNumber, String airDate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesEpisodes
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      season - (optional, default to 0)
      episodeNumber - (optional, default to 0)
      airDate - airDate of the episode, format is yyyy-mm-dd (optional)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesEpisodes

      public InlineResponse20048 getSeriesEpisodes(Integer page, BigDecimal id, String seasonType, Integer season, Integer episodeNumber, String airDate) throws ApiException
      Returns series episodes from the specified season type, default returns the episodes in the series default season type
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      season - (optional, default to 0)
      episodeNumber - (optional, default to 0)
      airDate - airDate of the episode, format is yyyy-mm-dd (optional)
      Returns:
      InlineResponse20048
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesEpisodesWithHttpInfo

      public ApiResponse<InlineResponse20048> getSeriesEpisodesWithHttpInfo(Integer page, BigDecimal id, String seasonType, Integer season, Integer episodeNumber, String airDate) throws ApiException
      Returns series episodes from the specified season type, default returns the episodes in the series default season type
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      season - (optional, default to 0)
      episodeNumber - (optional, default to 0)
      airDate - airDate of the episode, format is yyyy-mm-dd (optional)
      Returns:
      ApiResponse<InlineResponse20048>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesEpisodesAsync

      public okhttp3.Call getSeriesEpisodesAsync(Integer page, BigDecimal id, String seasonType, Integer season, Integer episodeNumber, String airDate, ApiCallback<InlineResponse20048> callback) throws ApiException
      (asynchronously) Returns series episodes from the specified season type, default returns the episodes in the series default season type
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      season - (optional, default to 0)
      episodeNumber - (optional, default to 0)
      airDate - airDate of the episode, format is yyyy-mm-dd (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

    • getSeriesExtendedCall

      public okhttp3.Call getSeriesExtendedCall(BigDecimal id, String meta, Boolean _short, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesExtended
      Parameters:
      id - id (required)
      meta - meta (optional)
      _short - reduce the payload and returns the short version of this record without characters and artworks (optional)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesExtended

      public InlineResponse20047 getSeriesExtended(BigDecimal id, String meta, Boolean _short) throws ApiException
      Returns series extended record
      Parameters:
      id - id (required)
      meta - meta (optional)
      _short - reduce the payload and returns the short version of this record without characters and artworks (optional)
      Returns:
      InlineResponse20047
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesExtendedWithHttpInfo

      public ApiResponse<InlineResponse20047> getSeriesExtendedWithHttpInfo(BigDecimal id, String meta, Boolean _short) throws ApiException
      Returns series extended record
      Parameters:
      id - id (required)
      meta - meta (optional)
      _short - reduce the payload and returns the short version of this record without characters and artworks (optional)
      Returns:
      ApiResponse<InlineResponse20047>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesExtendedAsync

      public okhttp3.Call getSeriesExtendedAsync(BigDecimal id, String meta, Boolean _short, ApiCallback<InlineResponse20047> callback) throws ApiException
      (asynchronously) Returns series extended record
      Parameters:
      id - id (required)
      meta - meta (optional)
      _short - reduce the payload and returns the short version of this record without characters and artworks (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

    • getSeriesFilterCall

      public okhttp3.Call getSeriesFilterCall(String country, String lang, BigDecimal company, BigDecimal contentRating, BigDecimal genre, String sort, String sortType, BigDecimal status, BigDecimal year, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesFilter
      Parameters:
      country - country of origin (required)
      lang - original language (required)
      company - production company (optional)
      contentRating - content rating id base on a country (optional)
      genre - Genre id. This id can be found using **_/genres** endpoint. (optional)
      sort - sort by results (optional)
      sortType - sort type ascending or descending (optional)
      status - status (optional)
      year - release year (optional)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesFilter

      public InlineResponse20050 getSeriesFilter(String country, String lang, BigDecimal company, BigDecimal contentRating, BigDecimal genre, String sort, String sortType, BigDecimal status, BigDecimal year) throws ApiException
      Search series based on filter parameters
      Parameters:
      country - country of origin (required)
      lang - original language (required)
      company - production company (optional)
      contentRating - content rating id base on a country (optional)
      genre - Genre id. This id can be found using **_/genres** endpoint. (optional)
      sort - sort by results (optional)
      sortType - sort type ascending or descending (optional)
      status - status (optional)
      year - release year (optional)
      Returns:
      InlineResponse20050
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesFilterWithHttpInfo

      public ApiResponse<InlineResponse20050> getSeriesFilterWithHttpInfo(String country, String lang, BigDecimal company, BigDecimal contentRating, BigDecimal genre, String sort, String sortType, BigDecimal status, BigDecimal year) throws ApiException
      Search series based on filter parameters
      Parameters:
      country - country of origin (required)
      lang - original language (required)
      company - production company (optional)
      contentRating - content rating id base on a country (optional)
      genre - Genre id. This id can be found using **_/genres** endpoint. (optional)
      sort - sort by results (optional)
      sortType - sort type ascending or descending (optional)
      status - status (optional)
      year - release year (optional)
      Returns:
      ApiResponse<InlineResponse20050>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesFilterAsync

      public okhttp3.Call getSeriesFilterAsync(String country, String lang, BigDecimal company, BigDecimal contentRating, BigDecimal genre, String sort, String sortType, BigDecimal status, BigDecimal year, ApiCallback<InlineResponse20050> callback) throws ApiException
      (asynchronously) Search series based on filter parameters
      Parameters:
      country - country of origin (required)
      lang - original language (required)
      company - production company (optional)
      contentRating - content rating id base on a country (optional)
      genre - Genre id. This id can be found using **_/genres** endpoint. (optional)
      sort - sort by results (optional)
      sortType - sort type ascending or descending (optional)
      status - status (optional)
      year - release year (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

    • getSeriesNextAiredCall

      public okhttp3.Call getSeriesNextAiredCall(BigDecimal id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesNextAired
      Parameters:
      id - id (required)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesNextAired

      public InlineResponse20046 getSeriesNextAired(BigDecimal id) throws ApiException
      Returns series base record including the nextAired field. <br> Note&#58; nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.
      Parameters:
      id - id (required)
      Returns:
      InlineResponse20046
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesNextAiredWithHttpInfo

      public ApiResponse<InlineResponse20046> getSeriesNextAiredWithHttpInfo(BigDecimal id) throws ApiException
      Returns series base record including the nextAired field. <br> Note&#58; nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.
      Parameters:
      id - id (required)
      Returns:
      ApiResponse<InlineResponse20046>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesNextAiredAsync

      public okhttp3.Call getSeriesNextAiredAsync(BigDecimal id, ApiCallback<InlineResponse20046> callback) throws ApiException
      (asynchronously) Returns series base record including the nextAired field. <br> Note&#58; nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.
      Parameters:
      id - id (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

    • getSeriesSeasonEpisodesTranslatedCall

      public okhttp3.Call getSeriesSeasonEpisodesTranslatedCall(Integer page, BigDecimal id, String seasonType, String lang, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesSeasonEpisodesTranslated
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      lang - (required)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesSeasonEpisodesTranslated

      public InlineResponse20049 getSeriesSeasonEpisodesTranslated(Integer page, BigDecimal id, String seasonType, String lang) throws ApiException
      Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      lang - (required)
      Returns:
      InlineResponse20049
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesSeasonEpisodesTranslatedWithHttpInfo

      public ApiResponse<InlineResponse20049> getSeriesSeasonEpisodesTranslatedWithHttpInfo(Integer page, BigDecimal id, String seasonType, String lang) throws ApiException
      Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      lang - (required)
      Returns:
      ApiResponse<InlineResponse20049>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesSeasonEpisodesTranslatedAsync

      public okhttp3.Call getSeriesSeasonEpisodesTranslatedAsync(Integer page, BigDecimal id, String seasonType, String lang, ApiCallback<InlineResponse20049> callback) throws ApiException
      (asynchronously) Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.
      Parameters:
      page - (required)
      id - id (required)
      seasonType - season-type (required)
      lang - (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

    • getSeriesTranslationCall

      public okhttp3.Call getSeriesTranslationCall(BigDecimal id, String language, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
      Build call for getSeriesTranslation
      Parameters:
      id - id (required)
      language - language (required)
      progressListener - Progress listener
      progressRequestListener - Progress request listener
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSeriesTranslation

      public InlineResponse20020 getSeriesTranslation(BigDecimal id, String language) throws ApiException
      Returns series translation record
      Parameters:
      id - id (required)
      language - language (required)
      Returns:
      InlineResponse20020
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesTranslationWithHttpInfo

      public ApiResponse<InlineResponse20020> getSeriesTranslationWithHttpInfo(BigDecimal id, String language) throws ApiException
      Returns series translation record
      Parameters:
      id - id (required)
      language - language (required)
      Returns:
      ApiResponse<InlineResponse20020>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSeriesTranslationAsync

      public okhttp3.Call getSeriesTranslationAsync(BigDecimal id, String language, ApiCallback<InlineResponse20020> callback) throws ApiException
      (asynchronously) Returns series translation record
      Parameters:
      id - id (required)
      language - language (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