com.uwetrottmann.tmdb2.services.MoviesService Maven / Gradle / Ivy
Show all versions of tmdb-java Show documentation
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.Credits;
import com.uwetrottmann.tmdb2.entities.Images;
import com.uwetrottmann.tmdb2.entities.Keywords;
import com.uwetrottmann.tmdb2.entities.ListResultsPage;
import com.uwetrottmann.tmdb2.entities.Movie;
import com.uwetrottmann.tmdb2.entities.MovieExternalIds;
import com.uwetrottmann.tmdb2.entities.MovieResultsPage;
import com.uwetrottmann.tmdb2.entities.RatingObject;
import com.uwetrottmann.tmdb2.entities.ReleaseDate;
import com.uwetrottmann.tmdb2.entities.ReleaseDatesResults;
import com.uwetrottmann.tmdb2.entities.ReviewResultsPage;
import com.uwetrottmann.tmdb2.entities.Status;
import com.uwetrottmann.tmdb2.entities.TmdbDate;
import com.uwetrottmann.tmdb2.entities.Translations;
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 MoviesService {
/**
* Get the basic movie information for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}")
Call summary(
@Path("movie_id") int movieId,
@Query("language") String language
);
/**
* Get the basic movie information for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param language Optional. ISO 639-1 code.
* @param appendToResponse Optional. extra requests to append to the result. Accepted Value(s): alternative_titles, changes, credits, images, keywords, release_dates, videos, translations, recommendations, similar, reviews, lists
*/
@GET("movie/{movie_id}")
Call summary(
@Path("movie_id") int movieId,
@Query("language") String language,
@Query("append_to_response") AppendToResponse appendToResponse
);
/**
* Get the basic movie information for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param language Optional. ISO 639-1 code.
* @param appendToResponse Optional. extra requests to append to the result. Accepted Value(s): alternative_titles, changes, credits, images, keywords, release_dates, videos, translations, recommendations, similar, reviews, lists
* @param options Optional. parameters for the appended extra results.
*/
@GET("movie/{movie_id}")
Call summary(
@Path("movie_id") int movieId,
@Query("language") String language,
@Query("append_to_response") AppendToResponse appendToResponse,
@QueryMap Map options
);
/**
* Grab the following account states for a session:
*
* * Movie rating
* * If it belongs to your watchlist
* * If it belongs to your favorite list
*
* Requires an active Session.
*
* @param movieId A Movie TMDb id.
*/
@GET("movie/{movie_id}/account_states")
Call accountStates(
@Path("movie_id") int movieId
);
/**
* Get the alternative titles for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param country Optional. ISO 3166-1 code.
*/
@GET("movie/{movie_id}/alternative_titles")
Call alternativeTitles(
@Path("movie_id") int movieId,
@Query("country") String country
);
/**
* Get the changes for a movie. 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.
*
* @param movieId A Movie 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("movie/{movie_id}/changes")
Call changes(
@Path("movie_id") int movieId,
@Query("start_date") TmdbDate start_date,
@Query("end_date") TmdbDate end_date,
@Query("page") Integer page
);
/**
* Get the cast and crew information for a specific movie id.
*
* @param movieId A Movie TMDb id.
*/
@GET("movie/{movie_id}/credits")
Call credits(
@Path("movie_id") int movieId
);
/**
* Get the external ids that we have stored for a movie.
*
* @param movieId A Movie TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/external_ids")
Call externalIds(
@Path("movie_id") int movieId,
@Query("language") String language
);
/**
* Get the images (posters and backdrops) for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/images")
Call images(
@Path("movie_id") int movieId,
@Query("language") String language
);
/**
* Get the plot keywords for a specific movie id.
*
* @param movieId A Movie TMDb id.
*/
@GET("movie/{movie_id}/keywords")
Call keywords(
@Path("movie_id") int movieId
);
/**
* Get the lists that the movie belongs to.
*
* @param movieId A Movie TMDb id.
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/lists")
Call lists(
@Path("movie_id") int movieId,
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the similar movies for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/similar")
Call similar(
@Path("movie_id") int movieId,
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the recommendations for a particular movie id.
*
* @param movieId A Movie TMDb id.
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/recommendations")
Call recommendations(
@Path("movie_id") int movieId,
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the release dates, certifications and related information by country for a specific movie id.
*
* The results are keyed by iso_3166_1 code and contain a type value which on our system, maps to:
* {@link ReleaseDate#TYPE_PREMIERE}, {@link ReleaseDate#TYPE_THEATRICAL_LIMITED},
* {@link ReleaseDate#TYPE_THEATRICAL}, {@link ReleaseDate#TYPE_DIGITAL}, {@link ReleaseDate#TYPE_PHYSICAL},
* {@link ReleaseDate#TYPE_TV}
*
* @param movieId A Movie TMDb id.
*/
@GET("movie/{movie_id}/release_dates")
Call releaseDates(
@Path("movie_id") int movieId
);
/**
* Get the reviews for a particular movie id.
*
* @param movieId A Movie TMDb id.
* @param page Optional. Minimum value is 1, expected value is an integer.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/reviews")
Call reviews(
@Path("movie_id") int movieId,
@Query("page") Integer page,
@Query("language") String language
);
/**
* Get the translations for a specific movie id.
*
* @param movieId A Movie TMDb id.
*/
@GET("movie/{movie_id}/translations")
Call translations(
@Path("movie_id") int movieId
);
/**
* Get the videos (trailers, teasers, clips, etc...) for a specific movie id.
*
* @param movieId A Movie TMDb id.
* @param language Optional. ISO 639-1 code.
*/
@GET("movie/{movie_id}/videos")
Call videos(
@Path("movie_id") int movieId,
@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("movie/{movie_id}/watch/providers")
Call watchProviders(
@Path("movie_id") int movieId
);
/**
* Get the latest movie id.
*/
@GET("movie/latest")
Call latest();
/**
* Get a list of movies in theatres. This is a release type query that looks
* for all movies that have a release type of 2 or 3 within the specified date range.
*
* You can optionally specify a region parameter which will narrow the search
* to only look for theatrical release dates within the specified country.
*
* @see Documentation
*/
@GET("movie/now_playing")
Call nowPlaying(
@Query("page") Integer page,
@Query("language") String language,
@Query("region") String region
);
/**
* Get a list of the current popular movies on TMDb. This list updates daily.
*
* @see Documentation
*/
@GET("movie/popular")
Call popular(
@Query("page") Integer page,
@Query("language") String language,
@Query("region") String region
);
/**
* Get the top rated movies on TMDb.
*
* @see Documentation
*/
@GET("movie/top_rated")
Call topRated(
@Query("page") Integer page,
@Query("language") String language,
@Query("region") String region
);
/**
* Get a list of upcoming movies in theatres. This is a release type query that looks
* for all movies that have a release type of 2 or 3 within the specified date range.
*
* You can optionally specify a region prameter which will narrow the search to
* only look for theatrical release dates within the specified country.
*
* @see Documentation
*/
@GET("movie/upcoming")
Call upcoming(
@Query("page") Integer page,
@Query("language") String language,
@Query("region") String region
);
/**
* Sets the Rating for the movie with the specified id.
*
* Requires an active Session.
*
* @param movieId A Movie TMDb id.
* @param body Required. A ReviewObject Object. Minimum value is 0.5 and Maximum 10.0, expected value is a number.
*/
@POST("movie/{movie_id}/rating")
Call addRating(
@Path("movie_id") Integer movieId,
@Body RatingObject body
);
/**
* Deletes the Rating for the movie with the specified id.
*
* Requires an active Session.
*
* @param movieId A Movie TMDb id.
*/
@DELETE("movie/{movie_id}/rating")
Call deleteRating(
@Path("movie_id") Integer movieId
);
}