com.uwetrottmann.trakt5.services.Sync Maven / Gradle / Ivy
package com.uwetrottmann.trakt5.services;
import com.uwetrottmann.trakt5.entities.BaseMovie;
import com.uwetrottmann.trakt5.entities.BaseShow;
import com.uwetrottmann.trakt5.entities.LastActivities;
import com.uwetrottmann.trakt5.entities.RatedEpisode;
import com.uwetrottmann.trakt5.entities.RatedMovie;
import com.uwetrottmann.trakt5.entities.RatedSeason;
import com.uwetrottmann.trakt5.entities.RatedShow;
import com.uwetrottmann.trakt5.entities.SyncItems;
import com.uwetrottmann.trakt5.entities.SyncResponse;
import com.uwetrottmann.trakt5.entities.WatchlistedEpisode;
import com.uwetrottmann.trakt5.entities.WatchlistedSeason;
import com.uwetrottmann.trakt5.enums.Extended;
import com.uwetrottmann.trakt5.enums.RatingsFilter;
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.http.Query;
import java.util.List;
public interface Sync {
/**
* OAuth Required
*
* This method is a useful first step in the syncing process. We recommended caching these dates locally, then
* you can compare to know exactly what data has changed recently. This can greatly optimize your syncs so you don't
* pull down a ton of data only to see nothing has actually changed.
*/
@GET("sync/last_activities")
Call lastActivities();
/**
* OAuth Required
*
* Get all collected movies in a user's collection. A collected item indicates availability to watch digitally
* or on physical media.
*/
@GET("sync/collection/movies")
Call> collectionMovies(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Get all collected shows in a user's collection. A collected item indicates availability to watch digitally or
* on physical media.
*/
@GET("sync/collection/shows")
Call> collectionShows(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Add one or more items to a user's collection including the format of the item.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/collection")
Call addItemsToCollection(
@Body SyncItems items
);
/**
* OAuth Required
*
* Remove one or more items from a user's collection.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/collection/remove")
Call deleteItemsFromCollection(
@Body SyncItems items
);
/**
* OAuth Required
*
* Returns all movies a user has watched.
*/
@GET("sync/watched/movies")
Call> watchedMovies(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Returns all shows a user has watched.
*/
@GET("sync/watched/shows")
Call> watchedShows(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Add items to a user's watch history. Accepts shows, seasons, episodes and movies. If only a show is passed,
* assumes all seasons are to be marked watched. Same for seasons. Send a watched_at UTC datetime to
* mark items as watched in the past. This is useful for syncing past watches from a media center.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/history")
Call addItemsToWatchedHistory(
@Body SyncItems items
);
/**
* OAuth Required
*
* Remove items from a user's watch history including all watches, scrobbles, and checkins. Accepts shows,
* seasons, episodes and movies. If only a show is passed, assumes all seasons are to be removed from history. Same
* for seasons.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/history/remove")
Call deleteItemsFromWatchedHistory(
@Body SyncItems items
);
/**
* OAuth Required
*
* Get a user's ratings filtered by movies. You can filter for a specific rating between 1 and 10.
*
* @param filter Filter for a specific rating.
*/
@GET("sync/ratings/movies{rating}")
Call> ratingsMovies(
@Path(value = "rating", encoded = true) RatingsFilter filter,
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Get a user's ratings filtered by shows. You can filter for a specific rating between 1 and 10.
*
* @param filter Filter for a specific rating.
*/
@GET("sync/ratings/shows{rating}")
Call> ratingsShows(
@Path(value = "rating", encoded = true) RatingsFilter filter,
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Get a user's ratings filtered by seasons. You can filter for a specific rating between 1 and 10.
*
* @param filter Filter for a specific rating.
*/
@GET("sync/ratings/seasons{rating}")
Call> ratingsSeasons(
@Path(value = "rating", encoded = true) RatingsFilter filter,
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Get a user's ratings filtered by episodes. You can filter for a specific rating between 1 and 10.
*
* @param filter Filter for a specific rating.
*/
@GET("sync/ratings/episodes{rating}")
Call> ratingsEpisodes(
@Path(value = "rating", encoded = true) RatingsFilter filter,
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Rate one or more items.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/ratings")
Call addRatings(
@Body SyncItems items
);
/**
* OAuth Required
*
* Delete ratings for one or more items.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/ratings/remove")
Call deleteRatings(
@Body SyncItems items
);
/**
* OAuth Required
*
* Returns all items in a user's watchlist filtered by movies. When an item is watched, it will be automatically
* removed from the watchlist. To track what the user is actively watching, use the progress APIs.
*/
@GET("sync/watchlist/movies")
Call> watchlistMovies(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Returns all items in a user's watchlist filtered by shows. When an item is watched, it will be automatically
* removed from the watchlist. To track what the user is actively watching, use the progress APIs.
*/
@GET("sync/watchlist/shows")
Call> watchlistShows(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Returns all items in a user's watchlist filtered by seasons. When an item is watched, it will be
* automatically removed from the watchlist. To track what the user is actively watching, use the progress APIs.
*/
@GET("sync/watchlist/seasons")
Call> watchlistSeasons(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Returns all items in a user's watchlist filtered by episodes. When an item is watched, it will be
* automatically removed from the watchlist. To track what the user is actively watching, use the progress APIs.
*/
@GET("sync/watchlist/episodes")
Call> watchlistEpisodes(
@Query(value = "extended", encoded = true) Extended extended
);
/**
* OAuth Required
*
* Add one of more items to a user's watchlist.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/watchlist")
Call addItemsToWatchlist(
@Body SyncItems items
);
/**
* OAuth Required
*
* Delete one or more items from a user's watchlist.
*
* @param items A list of movies, shows, seasons or episodes.
*/
@POST("sync/watchlist/remove")
Call deleteItemsFromWatchlist(
@Body SyncItems items
);
}