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

package com.uwetrottmann.trakt5.services;

import com.uwetrottmann.trakt5.entities.CalendarMovieEntry;
import com.uwetrottmann.trakt5.entities.CalendarShowEntry;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;

import java.util.List;

public interface Calendars {

    /**
     * OAuth Required
     *
     * @see #shows(String, int)
     */
    @GET("calendars/my/shows/{startdate}/{days}")
    Call> myShows(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * OAuth Required
     *
     * @see #newShows(String, int)
     */
    @GET("calendars/my/shows/new/{startdate}/{days}")
    Call> myNewShows(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * OAuth Required
     *
     * @see #seasonPremieres(String, int)
     */
    @GET("calendars/my/shows/premieres/{startdate}/{days}")
    Call> mySeasonPremieres(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * OAuth Required
     *
     * @see #movies(String, int)
     */
    @GET("calendars/my/movies/{startdate}/{days}")
    Call> myMovies(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * Returns all shows airing during the time period specified.
     *
     * @param startDate Start the calendar on this date. Example: 2014-09-01.
     * @param days Number of days to display. Example: 7.
     */
    @GET("calendars/all/shows/{startdate}/{days}")
    Call> shows(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * Returns all new show premieres (season 1, episode 1) airing during the time period specified.
     *
     * @param startDate Start the calendar on this date. Example: 2014-09-01.
     * @param days Number of days to display. Example: 7.
     */
    @GET("calendars/all/shows/new/{startdate}/{days}")
    Call> newShows(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * Returns all show premieres (any season, episode 1) airing during the time period specified.
     *
     * @param startDate Start the calendar on this date. Example: 2014-09-01.
     * @param days Number of days to display. Example: 7.
     */
    @GET("calendars/all/shows/premieres/{startdate}/{days}")
    Call> seasonPremieres(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

    /**
     * Returns all movies with a release date during the time period specified.
     *
     * @param startDate Start the calendar on this date. Example: 2014-09-01.
     * @param days Number of days to display. Example: 7.
     */
    @GET("calendars/all/movies/{startdate}/{days}")
    Call> movies(
            @Path("startdate") String startDate,
            @Path("days") int days
    );

}