import { TraktClientEndpoint, TraktApiParamsPagination, TraktApiParamsExtended } from '../../models/trakt-client.model.cjs'; import { e as TraktListList, d as TraktList, g as TraktListItem, T as TraktComment } from '../../trakt-list.model-DUX3arQu.cjs'; import { TraktLike } from '../../models/trakt-like.model.cjs'; import '@dvcol/base-http-client'; import '@dvcol/common-utils/common/models'; import '@dvcol/common-utils/http/fetch'; import '../trakt-api.filters.cjs'; import '../../models/trakt-entity.model.cjs'; import '../../models/trakt-id.model.cjs'; import '../../models/trakt-episode.model.cjs'; import '../../models/trakt-image.model.cjs'; import '../../models/trakt-people.model.cjs'; import '../../models/trakt-movie.model.cjs'; import '../../models/trakt-season.model.cjs'; import '../../models/trakt-show.model.cjs'; declare const lists: { /** * Returns all lists with the most likes and comments over the last 7 days. * * @pagination true - {@link TraktApiPagination} * @emoji true - [documentation]{@link https://trakt.docs.apiary.io/#introduction/emojis} * * @see [apiary]{@link https://trakt.docs.apiary.io/#reference/lists/trending} */ trending: TraktClientEndpoint; /** * Returns the most popular lists. Popularity is calculated using total number of likes and comments. * * @pagination true - {@link TraktApiPagination} * @emoji true - [documentation]{@link https://trakt.docs.apiary.io/#introduction/emojis} * * @see [apiary]{@link https://trakt.docs.apiary.io/#reference/lists/popular} */ popular: TraktClientEndpoint; /** * Returns a single list. Use the /lists/:id/items method to get the actual items this list contains. * * Note: You must use an integer id, and only public lists will return data. * * @emoji true - [documentation]{@link https://trakt.docs.apiary.io/#introduction/emojis} * * @see [list]{@link https://trakt.docs.apiary.io/#reference/lists/list} */ list: TraktClientEndpoint<{ /** Trakt ID (i.e. 15) */ id: number; }, TraktList, true>; /** * Returns all users who liked a list. * * @pagination true - {@link TraktApiPagination} * * @see [list-likes]{@link https://trakt.docs.apiary.io/#reference/lists/list-likes} */ likes: TraktClientEndpoint<{ /** Trakt ID (i.e. 15) */ id: number; } & TraktApiParamsPagination, TraktLike[], true>; like: { /** * Votes help determine popular lists. Only one like is allowed per list per user. * * @auth required * * @see [like-a-list]{@link https://trakt.docs.apiary.io/#reference/lists/list-like/like-a-list} */ add: TraktClientEndpoint<{ /** Trakt ID (i.e. 15) */ id: number; }, unknown, true>; /** * Remove a like on a list. * * @auth required * * @see [remove-like-on-a-list]{@link https://trakt.docs.apiary.io/#reference/lists/list-like/remove-like-on-a-list} */ remove: TraktClientEndpoint<{ /** Trakt ID (i.e. 15) */ id: number; }, unknown, false>; }; /** * Get all items on a personal list. * Items can be a movie, show, season, episode, or person. * You can optionally specify the type parameter with a single value or comma delimited string for multiple item types. * * * Notes * * Each list item contains a notes field with text entered by the user. * * * Sorting HeadersAll * * All list items are sorted by ascending rank. We also send X-Sort-By and X-Sort-How headers which can be used to custom sort the list in your app based on the user's preference. * Values for X-Sort-By include rank, added, title, released, runtime, popularity, percentage, votes, my_rating, random, watched, and collected. * Values for X-Sort-How include asc and desc. * * @pagination optional - {@link TraktApiPagination} * @extended true - {@link TraktApiExtended.Full} * @emoji true - [documentation]{@link https://trakt.docs.apiary.io/#introduction/emojis} * * @see [list-items]{@link https://trakt.docs.apiary.io/#reference/lists/list-items} */ items: TraktClientEndpoint<{ /** Trakt ID (i.e. 15) */ id: number; /** Filter for a specific item type */ type?: ('movie' | 'show' | 'season' | 'episode' | 'person') | ('movie' | 'show' | 'season' | 'episode' | 'person')[]; } & TraktApiParamsPagination & TraktApiParamsExtended<"full">, TraktListItem[], true>; /** * Returns all top level comments for a list. * By default, the newest comments are returned first. * Other sorting options include oldest, most likes, and most replies. * * Note: If you send OAuth, comments from blocked users will be automatically filtered out. * * @pagination true - {@link TraktApiPagination} * @emoji true - [documentation]{@link https://trakt.docs.apiary.io/#introduction/emojis} * @auth optional * * @see [list-comments]{@link https://trakt.docs.apiary.io/#reference/lists/list-comments} */ comments: TraktClientEndpoint<{ /** Trakt ID (i.e. 15) */ id: number; /** How to sort */ sort: 'newest' | 'oldest' | 'likes' | 'replies'; } & TraktApiParamsPagination, TraktComment[], true>; }; export { lists };