com.uwetrottmann.tmdb2.services.TvService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tmdb-java Show documentation
Show all versions of tmdb-java Show documentation
tmdb-java is a retrofit2 based wrapper around the themoviedb.org API v3.
The newest version!
package com.uwetrottmann.tmdb2.services;
import com.uwetrottmann.tmdb2.entities.AccountStates;
import com.uwetrottmann.tmdb2.entities.AlternativeTitles;
import com.uwetrottmann.tmdb2.entities.AppendToResponse;
import com.uwetrottmann.tmdb2.entities.Changes;
import com.uwetrottmann.tmdb2.entities.ContentRatings;
import com.uwetrottmann.tmdb2.entities.Credits;
import com.uwetrottmann.tmdb2.entities.Images;
import com.uwetrottmann.tmdb2.entities.Keywords;
import com.uwetrottmann.tmdb2.entities.RatingObject;
import com.uwetrottmann.tmdb2.entities.Status;
import com.uwetrottmann.tmdb2.entities.TmdbDate;
import com.uwetrottmann.tmdb2.entities.Translations;
import com.uwetrottmann.tmdb2.entities.TvCredits;
import com.uwetrottmann.tmdb2.entities.TvExternalIds;
import com.uwetrottmann.tmdb2.entities.TvShow;
import com.uwetrottmann.tmdb2.entities.TvShowResultsPage;
import com.uwetrottmann.tmdb2.entities.Videos;
import com.uwetrottmann.tmdb2.entities.WatchProviders;
import java.util.Map;
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.DELETE;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;
public interface TvService {
/**
* Get the primary information about a TV series by id.
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}")
Call tv(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* Get the primary information about a TV series by id.
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
* @param appendToResponse Optional. extra requests to append to the result.
*/
@GET("tv/{tv_id}")
Call tv(
@Path("tv_id") int tvShowId,
@Query("language") String language,
@Query("append_to_response") AppendToResponse appendToResponse
);
/**
* Get the primary information about a TV series by id.
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
* @param appendToResponse Optional. extra requests to append to the result.
* @param options Optional. parameters for the appended extra results.
*/
@GET("tv/{tv_id}")
Call tv(
@Path("tv_id") int tvShowId,
@Query("language") String language,
@Query("append_to_response") AppendToResponse appendToResponse,
@QueryMap Map options
);
/**
* Grab the following account states for a session:
*
* * TV show rating
* * If it belongs to your watchlist
* * If it belongs to your favourite list
*
* Requires an active Session.
*
* @param tvShowId TMDb id.
*/
@GET("tv/{tv_id}/account_states")
Call accountStates(
@Path("tv_id") int tvShowId
);
/**
* Get the alternative titles for a specific show ID.
*
* @param tvShowId A Tv Show TMDb id.
*/
@GET("tv/{tv_id}/alternative_titles")
Call alternativeTitles(
@Path("tv_id") int tvShowId
);
/**
* Get the changes for a TV show. By default only the last 24 hours are returned.
*
* You can query up to 14 days in a single query by using the start_date and end_date query parameters.
*
* TV show changes are different than movie changes in that there are some edits on seasons and episodes that will create a change entry at the show level.
* These can be found under the season and episode keys.
* These keys will contain a series_id and episode_id.
* You can use the season changes and episode changes methods to look these up individually.
*
* @param tvShowId A Tv Show TMDb id.
* @param start_date Optional. Starting date of changes occurred to a movie.
* @param end_date Optional. Ending date of changes occurred to a movie.
* @param page Optional. Minimum value is 1, expected value is an integer.
*/
@GET("tv/{tv_id}/changes")
Call changes(
@Path("tv_id") int tvShowId,
@Query("start_date") TmdbDate start_date,
@Query("end_date") TmdbDate end_date,
@Query("page") Integer page
);
/**
* @see Aggregate Credits
*/
@GET("tv/{tv_id}/aggregate_credits")
Call aggregateCredits(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* @see Credits
*/
@GET("tv/{tv_id}/credits")
Call credits(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* Get the content ratings for a specific TV show.
*
* @param tmbdId A Tv Show TMDb id.
*/
@GET("tv/{tv_id}/content_ratings")
Call content_ratings(
@Path("tv_id") int tmbdId
);
/**
* Get the external ids that we have stored for a TV series.
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}/external_ids")
Call externalIds(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* Get the images (posters and backdrops) for a TV series.
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}/images")
Call images(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* Get the plot keywords for a specific TV show id.
*
* @param tvShowId A Tv Show TMDb id.
*/
@GET("tv/{tv_id}/keywords")
Call keywords(
@Path("tv_id") int tvShowId
);
/**
* Get the list of TV show recommendations for this item.
*
* @param tvShowId A Tv Show TMDb id.
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}/recommendations")
Call recommendations(
@Path("tv_id") int tvShowId,
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the similar TV shows for a specific tv id.
*
* @param tvShowId A Tv Show TMDb id.
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}/similar")
Call similar(
@Path("tv_id") int tvShowId,
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get a list of the translations that exist for a TV show.
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}/translations")
Call translations(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* Get the videos that have been added to a TV series (trailers, opening credits, etc...)
*
* @param tvShowId A Tv Show TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/{tv_id}/videos")
Call videos(
@Path("tv_id") int tvShowId,
@Query("language") String language
);
/**
* Get a list of the availabilities per country by provider.
*
* Please note: In order to use this data you must attribute the source of the data as JustWatch.
*
* @see Documentation
*/
@GET("tv/{tv_id}/watch/providers")
Call watchProviders(
@Path("tv_id") int tvShowId
);
/**
* Get the latest TV show id.
*/
@GET("tv/latest")
Call latest();
/**
* Get the list of TV shows that are currently on the air. This query looks for any TV show that has an episode with
* an air date in the next 7 days.
*
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/on_the_air")
Call onTheAir(
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the list of TV shows that air today. Without a specified timezone, this query defaults to EST (Eastern Time
* UTC-05:00).
*
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/airing_today")
Call airingToday(
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the list of top rated TV shows. By default, this list will only include TV shows that have 2 or more votes.
* This list refreshes every day.
*
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/top_rated")
Call topRated(
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the list of popular TV shows. This list refreshes every day.
*
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("tv/popular")
Call popular(
@Query("page") Integer page,
@Query("language") String language
);
/**
* Rate a TV show.
*
* Requires an active Session.
*
* @param tvShowId TMDb id.
* @param body Required. A ReviewObject Object. Minimum value is 0.5 and Maximum 10.0, expected value is a number.
*/
@POST("tv/{tv_id}/rating")
Call addRating(
@Path("tv_id") Integer tvShowId,
@Body RatingObject body
);
/**
* Remove your rating for a TV show.
*
* Requires an active Session.
*
* @param tvShowId TMDb id.
*/
@DELETE("tv/{tv_id}/rating")
Call deleteRating(
@Path("tv_id") Integer tvShowId
);
}