@tdanks2000/tmdb-wrapper 1.0.0 → 1.0.2

package/dist/endpoints/people.js

@@ -10,12 +10,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PeopleEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
 const BASE_PERSON = '/person';
+/**
+ * Represents an endpoint for accessing information about people.
+ */
 class PeopleEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new PeopleEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves details of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @param {AppendToResponsePersonKey[]} [appendToResponse] - Optional keys to append to the response.
+     * @param {string} [language] - Optional parameter for specifying the language.
+     * @returns {Promise<AppendToResponse<PersonDetails, AppendToResponsePersonKey[], 'person'>>} A Promise that resolves with the details of the person.
+     */
     details(id, appendToResponse, language) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = {
@@ -25,51 +39,105 @@ class PeopleEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_PERSON}/${id}`, options);
         });
     }
+    /**
+     * Retrieves changes made to a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @param {ChangeOption} [options] - Optional parameters for filtering changes.
+     * @returns {Promise<Changes<PersonChangeValue>>} A Promise that resolves with the changes made to the person.
+     */
     changes(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/changes`, options);
         });
     }
+    /**
+     * Retrieves movie credits of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<PersonMovieCredit>} A Promise that resolves with the movie credits of the person.
+     */
     movieCredits(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/movie_credits`, options);
         });
     }
+    /**
+     * Retrieves TV show credits of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<PersonTvShowCredit>} A Promise that resolves with the TV show credits of the person.
+     */
     tvShowCredits(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/tv_credits`, options);
         });
     }
+    /**
+     * Retrieves combined credits of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<PersonCombinedCredits>} A Promise that resolves with the combined credits of the person.
+     */
     combinedCredits(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/combined_credits`, options);
         });
     }
+    /**
+     * Retrieves external IDs of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs of the person.
+     */
     externalId(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/external_ids`);
         });
     }
+    /**
+     * Retrieves images of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @returns {Promise<PeopleImages>} A Promise that resolves with the images of the person.
+     */
     images(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/images`);
         });
     }
+    /**
+     * Retrieves tagged images of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @param {PageOption} [options] - Optional parameters for specifying pagination options.
+     * @returns {Promise<TaggedImages>} A Promise that resolves with the tagged images of the person.
+     */
     taggedImages(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/tagged_images`, options);
         });
     }
+    /**
+     * Retrieves translations of a specific person asynchronously.
+     * @param {number} id - The ID of the person.
+     * @returns {Promise<PersonTranslations>} A Promise that resolves with the translations of the person.
+     */
     translation(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/${id}/translations`);
         });
     }
+    /**
+     * Retrieves details of the latest person asynchronously.
+     * @returns {Promise<PersonDetails>} A Promise that resolves with the details of the latest person.
+     */
     latest() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/latest`);
         });
     }
+    /**
+     * Retrieves popular persons asynchronously.
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying language and pagination options.
+     * @returns {Promise<PopularPersons>} A Promise that resolves with the popular persons.
+     */
     popular(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_PERSON}/popular`, options);

package/dist/endpoints/review.d.ts

@@ -1,6 +1,18 @@
-import { BaseEndpoint, ReviewDetails } from '@/@types';
+import { BaseEndpoint, ReviewDetails } from '../@types';
+/**
+ * Represents an endpoint for accessing review details.
+ */
 export declare class ReviewEndpoint extends BaseEndpoint {
+    /**
+     * Constructs a new ReviewEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves details of a specific review asynchronously.
+     * @param {string} id - The ID of the review.
+     * @returns {Promise<ReviewDetails>} A Promise that resolves with the details of the review.
+     */
     details(id: string): Promise<ReviewDetails>;
 }
 //# sourceMappingURL=review.d.ts.map

package/dist/endpoints/review.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/endpoints/review.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEvD,qBAAa,cAAe,SAAQ,YAAY;gBAClC,YAAY,EAAE,MAAM;IAI1B,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAGlD"}
+{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/endpoints/review.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEvD;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;OAIG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAGlD"}

package/dist/endpoints/review.js

@@ -10,11 +10,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReviewEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
+/**
+ * Represents an endpoint for accessing review details.
+ */
 class ReviewEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new ReviewEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves details of a specific review asynchronously.
+     * @param {string} id - The ID of the review.
+     * @returns {Promise<ReviewDetails>} A Promise that resolves with the details of the review.
+     */
     details(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`/review/${id}`);

package/dist/endpoints/search.d.ts

@@ -1,39 +1,58 @@
-import { BaseEndpoint, Collection, Company, LanguageOption, Movie, MultiSearchResult, PageOption, Person, RegionOption, Search, TV } from '@/@types';
-export interface SearchOptions {
-    query: string;
-    page?: number;
-}
-export interface MovieSearchOptions extends SearchOptions, LanguageOption, PageOption, RegionOption {
-    include_adult?: boolean;
-    year?: number;
-    primary_release_year?: number;
-}
-export interface CollectionSearchOptions extends SearchOptions, LanguageOption, PageOption, RegionOption {
-    include_adult?: boolean;
-}
-export interface TvSearchOptions extends SearchOptions, LanguageOption, PageOption {
-    include_adult?: boolean;
-    year?: number;
-    first_air_date_year?: number;
-}
-export interface PeopleSearchOptions extends SearchOptions, LanguageOption, PageOption {
-    include_adult?: boolean;
-}
-export interface MultiSearchOptions extends SearchOptions, LanguageOption, PageOption {
-    include_adult?: boolean;
-}
+import { BaseEndpoint, Collection, Company, Movie, MovieSearchOptions, MultiSearchOptions, MultiSearchResult, PeopleSearchOptions, Person, Search, SearchOptions, TV, TvSearchOptions } from '../@types';
+/**
+ * Represents an endpoint for performing various search operations.
+ */
 export declare class SearchEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new SearchEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Searches for companies asynchronously.
+     * @param {SearchOptions} options - The search options.
+     * @returns {Promise<Search<Company>>} A Promise that resolves with the search results for companies.
+     */
     companies(options: SearchOptions): Promise<Search<Company>>;
+    /**
+     * Searches for collections asynchronously.
+     * @param {SearchOptions} options - The search options.
+     * @returns {Promise<Search<Collection>>} A Promise that resolves with the search results for collections.
+     */
     collections(options: SearchOptions): Promise<Search<Collection>>;
+    /**
+     * Searches for keywords asynchronously.
+     * @param {SearchOptions} options - The search options.
+     * @returns {Promise<Search<{ id: string; name: string }>>} A Promise that resolves with the search results for keywords.
+     */
     keywords(options: SearchOptions): Promise<Search<{
         id: string;
         name: string;
     }>>;
+    /**
+     * Searches for movies asynchronously.
+     * @param {MovieSearchOptions} options - The search options.
+     * @returns {Promise<Search<Movie>>} A Promise that resolves with the search results for movies.
+     */
     movies(options: MovieSearchOptions): Promise<Search<Movie>>;
+    /**
+     * Searches for people asynchronously.
+     * @param {PeopleSearchOptions} options - The search options.
+     * @returns {Promise<Search<Person>>} A Promise that resolves with the search results for people.
+     */
     people(options: PeopleSearchOptions): Promise<Search<Person>>;
+    /**
+     * Searches for TV shows asynchronously.
+     * @param {TvSearchOptions} options - The search options.
+     * @returns {Promise<Search<TV>>} A Promise that resolves with the search results for TV shows.
+     */
     tv(options: TvSearchOptions): Promise<Search<TV>>;
+    /**
+     * Performs a multi-search asynchronously.
+     * @param {MultiSearchOptions} options - The search options.
+     * @returns {Promise<Search<MultiSearchResult>>} A Promise that resolves with the multi-search results.
+     */
     multi(options: MultiSearchOptions): Promise<Search<MultiSearchResult>>;
 }
 //# sourceMappingURL=search.d.ts.map

package/dist/endpoints/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/endpoints/search.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EACV,OAAO,EACP,cAAc,EACd,KAAK,EACL,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,YAAY,EACZ,MAAM,EACN,EAAE,EACH,MAAM,UAAU,CAAC;AAIlB,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY;IACjG,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY;IACtG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,eAAgB,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU;IAChF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU;IACpF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU;IACnF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,qBAAa,cAAe,SAAQ,YAAY;IAClC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAI3D,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAIhE,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAI/E,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAI3D,MAAM,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAI7D,EAAE,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAIjD,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;CAG7E"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/endpoints/search.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EACV,OAAO,EACP,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,MAAM,EACN,MAAM,EACN,aAAa,EACb,EAAE,EACF,eAAe,EAChB,MAAM,UAAU,CAAC;AAIlB;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAKlC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAJnD;;;OAGG;gBAC4B,YAAY,EAAE,MAAM;IAInD;;;;OAIG;IACG,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAIjE;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAItE;;;;OAIG;IACG,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAIrF;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAIjE;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAInE;;;;OAIG;IACG,EAAE,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAIvD;;;;OAIG;IACG,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;CAG7E"}

package/dist/endpoints/search.js

@@ -10,43 +10,85 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
 const BASE_SEARCH = '/search';
+/**
+ * Represents an endpoint for performing various search operations.
+ */
 class SearchEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new SearchEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
         this.access_token = access_token;
     }
+    /**
+     * Searches for companies asynchronously.
+     * @param {SearchOptions} options - The search options.
+     * @returns {Promise<Search<Company>>} A Promise that resolves with the search results for companies.
+     */
     companies(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/company`, options);
         });
     }
+    /**
+     * Searches for collections asynchronously.
+     * @param {SearchOptions} options - The search options.
+     * @returns {Promise<Search<Collection>>} A Promise that resolves with the search results for collections.
+     */
     collections(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/collection`, options);
         });
     }
+    /**
+     * Searches for keywords asynchronously.
+     * @param {SearchOptions} options - The search options.
+     * @returns {Promise<Search<{ id: string; name: string }>>} A Promise that resolves with the search results for keywords.
+     */
     keywords(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/keyword`, options);
         });
     }
+    /**
+     * Searches for movies asynchronously.
+     * @param {MovieSearchOptions} options - The search options.
+     * @returns {Promise<Search<Movie>>} A Promise that resolves with the search results for movies.
+     */
     movies(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/movie`, options);
         });
     }
+    /**
+     * Searches for people asynchronously.
+     * @param {PeopleSearchOptions} options - The search options.
+     * @returns {Promise<Search<Person>>} A Promise that resolves with the search results for people.
+     */
     people(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/person`, options);
         });
     }
+    /**
+     * Searches for TV shows asynchronously.
+     * @param {TvSearchOptions} options - The search options.
+     * @returns {Promise<Search<TV>>} A Promise that resolves with the search results for TV shows.
+     */
     tv(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/tv`, options);
         });
     }
+    /**
+     * Performs a multi-search asynchronously.
+     * @param {MultiSearchOptions} options - The search options.
+     * @returns {Promise<Search<MultiSearchResult>>} A Promise that resolves with the multi-search results.
+     */
     multi(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_SEARCH}/multi`, options);

package/dist/endpoints/trending.d.ts

@@ -1,6 +1,21 @@
-import { BaseEndpoint, LanguageOption, TimeWindow, TrendingMediaType, TrendingResults } from '@/@types';
+import { BaseEndpoint, LanguageOption, PageOption, TimeWindow, TrendingMediaType, TrendingResults } from '../@types';
+/**
+ * Represents an endpoint for retrieving trending content.
+ */
 export declare class TrendingEndpoint extends BaseEndpoint {
+    /**
+     * Constructs a new TrendingEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
-    trending<T extends TrendingMediaType>(mediaType: T, timeWindow: TimeWindow, options?: LanguageOption): Promise<TrendingResults<T>>;
+    /**
+     * Retrieves trending content asynchronously based on media type and time window.
+     * @param {TrendingMediaType} mediaType - The type of media (e.g., 'all', 'movie', 'tv').
+     * @param {TimeWindow} timeWindow - The time window for trending content (e.g., 'day', 'week').
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying the language and pagination.
+     * @returns {Promise<TrendingResults<T>>} A Promise that resolves with the trending results.
+     * @template T - The type of media being searched for (e.g., 'movie', 'tv').
+     */
+    trending<T extends TrendingMediaType>(mediaType: T, timeWindow: TimeWindow, options?: LanguageOption & PageOption): Promise<TrendingResults<T>>;
 }
 //# sourceMappingURL=trending.d.ts.map

package/dist/endpoints/trending.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trending.d.ts","sourceRoot":"","sources":["../../src/endpoints/trending.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAExG,qBAAa,gBAAiB,SAAQ,YAAY;gBACpC,YAAY,EAAE,MAAM;IAI1B,QAAQ,CAAC,CAAC,SAAS,iBAAiB,EACxC,SAAS,EAAE,CAAC,EACZ,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAG/B"}
+{"version":3,"file":"trending.d.ts","sourceRoot":"","sources":["../../src/endpoints/trending.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEpH;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;;;;OAOG;IACG,QAAQ,CAAC,CAAC,SAAS,iBAAiB,EACxC,SAAS,EAAE,CAAC,EACZ,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GACpC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAG/B"}

package/dist/endpoints/trending.js

@@ -10,11 +10,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TrendingEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
+/**
+ * Represents an endpoint for retrieving trending content.
+ */
 class TrendingEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new TrendingEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves trending content asynchronously based on media type and time window.
+     * @param {TrendingMediaType} mediaType - The type of media (e.g., 'all', 'movie', 'tv').
+     * @param {TimeWindow} timeWindow - The time window for trending content (e.g., 'day', 'week').
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying the language and pagination.
+     * @returns {Promise<TrendingResults<T>>} A Promise that resolves with the trending results.
+     * @template T - The type of media being searched for (e.g., 'movie', 'tv').
+     */
     trending(mediaType, timeWindow, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`/trending/${mediaType}/${timeWindow}`, options);

package/dist/endpoints/tvEpisodes.d.ts

@@ -1,24 +1,61 @@
-import { AppendToResponse, AppendToResponseTvEpisodeKey, BaseEndpoint, ChangeOption, Changes, Episode, EpisodeSelection, ExternalIds, Images, LanguageOption, TvEpisodeCredit, TvEpisodeTranslations, Videos } from '@/@types';
-export interface TvEpisodeImageSearchOptions extends LanguageOption {
+import { AppendToResponse, AppendToResponseTvEpisodeKey, BaseEndpoint, ChangeOption, Changes, Episode, EpisodeSelection, ExternalIds, Images, LanguageOption, TvEpisodeCredit, TvEpisodeImageSearchOptions, TvEpisodeTranslations, TvEpisodeVideoSearchOptions, Videos } from '../@types';
+/**
+ * Represents an endpoint for accessing TV episode-related information.
+ */
+export declare class TvEpisodesEndpoint extends BaseEndpoint {
     /**
-     * a list of ISO-639-1 values to query
+     * Constructs a new TvEpisodesEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
      */
-    include_image_language?: string[];
-}
-export interface TvEpisodeVideoSearchOptions extends LanguageOption {
+    constructor(access_token: string);
     /**
-     * a list of ISO-639-1 values to query
+     * Retrieves details of a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {AppendToResponseTvEpisodeKey[]} [appendToResponse] - Additional data to append to the response.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<AppendToResponse<Omit<Episode, 'show_id'>, AppendToResponseTvEpisodeKey[], 'tvEpisode'>>}
+     * A Promise that resolves with the details of the TV episode.
      */
-    include_video_language?: string[];
-}
-export declare class TvEpisodesEndpoint extends BaseEndpoint {
-    constructor(access_token: string);
     details<T extends AppendToResponseTvEpisodeKey[] | undefined>(episodeSelection: EpisodeSelection, appendToResponse?: T, options?: LanguageOption): Promise<AppendToResponse<Omit<Episode, "show_id">, T, "tvEpisode">>;
+    /**
+     * Retrieves changes related to a specific TV episode asynchronously.
+     * @param {number} episodeID - The ID of the TV episode.
+     * @param {ChangeOption} [options] - Optional parameters for specifying changes.
+     * @returns {Promise<Changes<TvEpisodeChangeValue>>} A Promise that resolves with the changes related to the TV episode.
+     */
     changes(episodeID: number, options?: ChangeOption): Promise<Changes<unknown>>;
+    /**
+     * Retrieves credits for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<TvEpisodeCredit>} A Promise that resolves with the credits for the TV episode.
+     */
     credits(episodeSelection: EpisodeSelection, options?: LanguageOption): Promise<TvEpisodeCredit>;
+    /**
+     * Retrieves external IDs for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs for the TV episode.
+     */
     externalIds(episodeSelection: EpisodeSelection): Promise<ExternalIds>;
+    /**
+     * Retrieves images for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {TvEpisodeImageSearchOptions} [options] - Optional parameters for specifying image search options.
+     * @returns {Promise<Images>} A Promise that resolves with the images for the TV episode.
+     */
     images(episodeSelection: EpisodeSelection, options?: TvEpisodeImageSearchOptions): Promise<Images>;
+    /**
+     * Retrieves translations for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @returns {Promise<TvEpisodeTranslations>} A Promise that resolves with the translations for the TV episode.
+     */
     translations(episodeSelection: EpisodeSelection): Promise<TvEpisodeTranslations>;
+    /**
+     * Retrieves videos for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {TvEpisodeVideoSearchOptions} [options] - Optional parameters for specifying video search options.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos for the TV episode.
+     */
     videos(episodeSelection: EpisodeSelection, options?: TvEpisodeVideoSearchOptions): Promise<Videos>;
 }
 //# sourceMappingURL=tvEpisodes.d.ts.map

package/dist/endpoints/tvEpisodes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tvEpisodes.d.ts","sourceRoot":"","sources":["../../src/endpoints/tvEpisodes.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,gBAAgB,EAChB,WAAW,EACX,MAAM,EACN,cAAc,EAEd,eAAe,EACf,qBAAqB,EACrB,MAAM,EACP,MAAM,UAAU,CAAC;AAMlB,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,qBAAa,kBAAmB,SAAQ,YAAY;gBACtC,YAAY,EAAE,MAAM;IAI1B,OAAO,CAAC,CAAC,SAAS,4BAA4B,EAAE,GAAG,SAAS,EAChE,gBAAgB,EAAE,gBAAgB,EAClC,gBAAgB,CAAC,EAAE,CAAC,EACpB,OAAO,CAAC,EAAE,cAAc;IAapB,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAIjD,OAAO,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc;IAIpE,WAAW,CAAC,gBAAgB,EAAE,gBAAgB;IAI9C,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,2BAA2B;IAQhF,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;IAI/C,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,2BAA2B;CAOvF"}
+{"version":3,"file":"tvEpisodes.d.ts","sourceRoot":"","sources":["../../src/endpoints/tvEpisodes.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,gBAAgB,EAChB,WAAW,EACX,MAAM,EACN,cAAc,EAEd,eAAe,EACf,2BAA2B,EAC3B,qBAAqB,EACrB,2BAA2B,EAC3B,MAAM,EACP,MAAM,UAAU,CAAC;AAMlB;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAClD;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;;;;OAOG;IACG,OAAO,CAAC,CAAC,SAAS,4BAA4B,EAAE,GAAG,SAAS,EAChE,gBAAgB,EAAE,gBAAgB,EAClC,gBAAgB,CAAC,EAAE,CAAC,EACpB,OAAO,CAAC,EAAE,cAAc;IAa1B;;;;;OAKG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAIvD;;;;;OAKG;IACG,OAAO,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc;IAI1E;;;;OAIG;IACG,WAAW,CAAC,gBAAgB,EAAE,gBAAgB;IAIpD;;;;;OAKG;IACG,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,2BAA2B;IAQtF;;;;OAIG;IACG,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;IAIrD;;;;;OAKG;IACG,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,2BAA2B;CAOvF"}

package/dist/endpoints/tvEpisodes.js

@@ -10,35 +10,73 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TvEpisodesEndpoint = void 0;
-const _types_1 = require("@/@types");
+const _types_1 = require("../@types");
 const BASE_EPISODE = (episodeSelection) => {
     return `/tv/${episodeSelection.tvShowID}/season/${episodeSelection.seasonNumber}/episode/${episodeSelection.episodeNumber}`;
 };
+/**
+ * Represents an endpoint for accessing TV episode-related information.
+ */
 class TvEpisodesEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new TvEpisodesEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves details of a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {AppendToResponseTvEpisodeKey[]} [appendToResponse] - Additional data to append to the response.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<AppendToResponse<Omit<Episode, 'show_id'>, AppendToResponseTvEpisodeKey[], 'tvEpisode'>>}
+     * A Promise that resolves with the details of the TV episode.
+     */
     details(episodeSelection, appendToResponse, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const combinedOptions = Object.assign({ append_to_response: appendToResponse ? appendToResponse.join(',') : undefined }, options);
             return yield this.api.get(`${BASE_EPISODE(episodeSelection)}`, combinedOptions);
         });
     }
+    /**
+     * Retrieves changes related to a specific TV episode asynchronously.
+     * @param {number} episodeID - The ID of the TV episode.
+     * @param {ChangeOption} [options] - Optional parameters for specifying changes.
+     * @returns {Promise<Changes<TvEpisodeChangeValue>>} A Promise that resolves with the changes related to the TV episode.
+     */
     changes(episodeID, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`/tv/episode/${episodeID}/changes`, options);
         });
     }
+    /**
+     * Retrieves credits for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<TvEpisodeCredit>} A Promise that resolves with the credits for the TV episode.
+     */
     credits(episodeSelection, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_EPISODE(episodeSelection)}/credits`, options);
         });
     }
+    /**
+     * Retrieves external IDs for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs for the TV episode.
+     */
     externalIds(episodeSelection) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_EPISODE(episodeSelection)}/external_ids`);
         });
     }
+    /**
+     * Retrieves images for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {TvEpisodeImageSearchOptions} [options] - Optional parameters for specifying image search options.
+     * @returns {Promise<Images>} A Promise that resolves with the images for the TV episode.
+     */
     images(episodeSelection, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -49,11 +87,22 @@ class TvEpisodesEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_EPISODE(episodeSelection)}/images`, computedOptions);
         });
     }
+    /**
+     * Retrieves translations for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @returns {Promise<TvEpisodeTranslations>} A Promise that resolves with the translations for the TV episode.
+     */
     translations(episodeSelection) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_EPISODE(episodeSelection)}/translations`);
         });
     }
+    /**
+     * Retrieves videos for a specific TV episode asynchronously.
+     * @param {EpisodeSelection} episodeSelection - The selection criteria for the TV episode.
+     * @param {TvEpisodeVideoSearchOptions} [options] - Optional parameters for specifying video search options.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos for the TV episode.
+     */
     videos(episodeSelection, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {