com.uwetrottmann.tmdb2.services.ListsService 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
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.List;
import com.uwetrottmann.tmdb2.entities.ListCreateRequest;
import com.uwetrottmann.tmdb2.entities.ListCreateResponse;
import com.uwetrottmann.tmdb2.entities.ListItemStatus;
import com.uwetrottmann.tmdb2.entities.ListOperation;
import com.uwetrottmann.tmdb2.entities.Status;
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;

public interface ListsService {

    /**
     * Get the details of a list.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     */
    @GET("list/{list_id}")
    Call summary(
            @Path("list_id") String listId
    );

    /**
     * Get the details of a list.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     */
    @GET("list/{list_id}")
    Call summary(
            @Path("list_id") Integer listId
    );

    /**
     * Check if a movie is listed in a list.
     *
     * @param listId  A BaseList TMDb id.(String/Integer).
     * @param movieId Movie Id.
     */
    @GET("list/{list_id}/item_status")
    Call itemStatus(
            @Path("list_id") String listId,
            @Query("movie_id") Integer movieId);

    /**
     * Check if a movie is listed in a list.
     *
     * @param listId  A BaseList TMDb id.(String/Integer).
     * @param movieId Movie Id.
     */
    @GET("list/{list_id}/item_status")
    Call itemStatus(
            @Path("list_id") Integer listId,
            @Query("movie_id") Integer movieId);

    /**
     * Create a list.
     * 
     * Requires an active Session.
     */
    @POST("list")
    Call createList(
            @Body ListCreateRequest request
    );

    /**
     * Add movie to list.
     * 

     * Requires an active Session.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     * @param item   The Body to send. ({@link com.uwetrottmann.tmdb2.entities.ListOperation ListOperation})
     */
    @POST("list/{list_id}/add_item")
    Call addMovie(
            @Path("list_id") String listId,
            @Body ListOperation item
    );

    /**
     * Add movie to list.
     * 

     * Requires an active Session.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     * @param item   The Body to send. ({@link com.uwetrottmann.tmdb2.entities.ListOperation ListOperation})
     */
    @POST("list/{list_id}/add_item")
    Call addMovie(
            @Path("list_id") Integer listId,
            @Body ListOperation item
    );

    /**
     * Remove a movie from a list.
     * 

     * Requires an active Session.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     * @param item   The Body to send. ({@link com.uwetrottmann.tmdb2.entities.ListOperation ListOperation})
     */
    @POST("list/{list_id}/remove_item")
    Call removeMovie(
            @Path("list_id") String listId,
            @Body ListOperation item
    );

    /**
     * Remove a movie from a list.
     * 

     * Requires an active Session.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     * @param item   The Body to send. ({@link com.uwetrottmann.tmdb2.entities.ListOperation ListOperation})
     */
    @POST("list/{list_id}/remove_item")
    Call removeMovie(
            @Path("list_id") Integer listId,
            @Body ListOperation item
    );

    /**
     * Clear all of the items from a list.
     * 

     * Requires an active Session.
     *
     * @param listId  A BaseList TMDb id.(String/Integer).
     * @param confirm Confirmation (Boolean).
     */
    @POST("list/{list_id}/clear")
    Call clear(
            @Path("list_id") String listId,
            @Query("confirm") Boolean confirm
    );

    /**
     * Clear all of the items from a list.
     * 

     * Requires an active Session.
     *
     * @param listId  A BaseList TMDb id.(String/Integer).
     * @param confirm Confirmation (Boolean).
     */
    @POST("list/{list_id}/clear")
    Call clear(
            @Path("list_id") Integer listId,
            @Query("confirm") Boolean confirm
    );

    /**
     * Delete a list.
     * 

     * Requires an active Session.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     */
    @DELETE("list/{list_id}")
    Call delete(
            @Path("list_id") String listId
    );


    /**
     * Delete a list.
     * 
     * Requires an active Session.
     *
     * @param listId A BaseList TMDb id.(String/Integer).
     */
    @DELETE("list/{list_id}")
    Call delete(
            @Path("list_id") Integer listId
    );

}