com.uwetrottmann.trakt5.services.Recommendations Maven / Gradle / Ivy

package com.uwetrottmann.trakt5.services;

import com.uwetrottmann.trakt5.entities.Movie;
import com.uwetrottmann.trakt5.entities.Show;
import com.uwetrottmann.trakt5.enums.Extended;
import retrofit2.Call;
import retrofit2.http.DELETE;
import retrofit2.http.GET;
import retrofit2.http.Path;
import retrofit2.http.Query;

import java.util.List;

public interface Recommendations {

    /**
     * OAuth Required
     *
     *  Personalized movie recommendations for a user. Results returned with the top recommendation first.
     */
    @GET("recommendations/movies")
    Call> movies(
            @Query(value = "extended", encoded = true) Extended extended
    );

    /**
     * OAuth Required
     *
     * 
 Dismiss a movie from getting recommended anymore.
     *
     * @param movieId trakt ID, trakt slug, or IMDB ID. Example: "tron-legacy-2010".
     */
    @DELETE("recommendations/movies/{id}")
    Call dismissMovie(
            @Path("id") String movieId
    );

    /**
     * OAuth Required
     *
     * 
 Personalized show recommendations for a user. Results returned with the top recommendation first.
     */
    @GET("recommendations/shows")
    Call> shows(
            @Query(value = "extended", encoded = true) Extended extended
    );

    /**
     * OAuth Required
     *
     *  Dismiss a show from getting recommended anymore.
     *
     * @param showId trakt ID, trakt slug, or IMDB ID. Example: 922.
     */
    @DELETE("recommendations/shows/{id}")
    Call dismissShow(
            @Path("id") String showId
    );

}