@tdanks2000/tmdb-wrapper 1.0.0 → 1.0.1

package/dist/endpoints/movies.js

@@ -12,11 +12,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MoviesEndpoint = void 0;
 const _types_1 = require("@/@types");
 const BASE_MOVIE = '/movie';
+/**
+ * Represents an endpoint for accessing movie-related information.
+ */
 class MoviesEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new MoviesEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
         this.access_token = access_token;
     }
+    /**
+     * Retrieves details of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {AppendToResponseMovieKey[]} [appendToResponse] - Optional keys to append to the response.
+     * @param {string} [language] - Optional parameter for specifying the language.
+     * @returns {Promise<AppendToResponse<MovieDetails, AppendToResponseMovieKey[], 'movie'>>} A Promise that resolves with the details of the movie.
+     */
     details(id, appendToResponse, language) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = {
@@ -26,26 +40,54 @@ class MoviesEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_MOVIE}/${id}`, options);
         });
     }
+    /**
+     * Retrieves alternative titles of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @returns {Promise<AlternativeTitles>} A Promise that resolves with the alternative titles of the movie.
+     */
     alternativeTitles(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/alternative_titles`);
         });
     }
+    /**
+     * Retrieves changes made to a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {ChangeOption} [options] - Optional parameters for filtering changes.
+     * @returns {Promise<Changes<MovieChangeValue>>} A Promise that resolves with the changes made to the movie.
+     */
     changes(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/changes`, options);
         });
     }
+    /**
+     * Retrieves credits of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Credits>} A Promise that resolves with the credits of the movie.
+     */
     credits(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/credits`, options);
         });
     }
+    /**
+     * Retrieves external IDs of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @returns {Promise<ExternalIds>} A Promise that resolves with the external IDs of the movie.
+     */
     externalIds(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/external_ids`);
         });
     }
+    /**
+     * Retrieves images of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {MoviesImageSearchOptions} [options] - Optional parameters for specifying image search options.
+     * @returns {Promise<Images>} A Promise that resolves with the images of the movie.
+     */
     images(id, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -56,75 +98,145 @@ class MoviesEndpoint extends _types_1.BaseEndpoint {
             return yield this.api.get(`${BASE_MOVIE}/${id}/images`, computedOptions);
         });
     }
+    /**
+     * Retrieves keywords of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @returns {Promise<Keywords>} A Promise that resolves with the keywords of the movie.
+     */
     keywords(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/keywords`);
         });
     }
+    /**
+     * Retrieves lists containing a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying language and pagination options.
+     * @returns {Promise<MovieLists>} A Promise that resolves with the lists containing the movie.
+     */
     lists(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/lists`, options);
         });
     }
+    /**
+     * Retrieves recommendations for a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying language and pagination options.
+     * @returns {Promise<Recommendations>} A Promise that resolves with the recommendations for the movie.
+     */
     recommendations(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/recommendations`, options);
         });
     }
+    /**
+     * Retrieves release dates of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @returns {Promise<ReleaseDates>} A Promise that resolves with the release dates of the movie.
+     */
     releaseDates(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/release_dates`);
         });
     }
+    /**
+     * Retrieves reviews for a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying language and pagination options.
+     * @returns {Promise<Reviews>} A Promise that resolves with the reviews for the movie.
+     */
     reviews(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/reviews`, options);
         });
     }
+    /**
+     * Retrieves similar movies for a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying language and pagination options.
+     * @returns {Promise<SimilarMovies>} A Promise that resolves with the similar movies for the movie.
+     */
     similar(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/similar`, options);
         });
     }
+    /**
+     * Retrieves translations of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @returns {Promise<Translations>} A Promise that resolves with the translations of the movie.
+     */
     translations(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/translations`);
         });
     }
+    /**
+     * Retrieves videos of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Videos>} A Promise that resolves with the videos of the movie.
+     */
     videos(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/videos`, options);
         });
     }
     /**
-     * Powered by JustWatch
-     * @param id
+     * Retrieves watch providers of a specific movie asynchronously.
+     * @param {number} id - The ID of the movie.
+     * @returns {Promise<WatchProviders>} A Promise that resolves with the watch providers of the movie.
      */
     watchProviders(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/${id}/watch/providers`);
         });
     }
+    /**
+     * Retrieves details of the latest movie asynchronously.
+     * @returns {Promise<LatestMovie>} A Promise that resolves with the details of the latest movie.
+     */
     latest() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/latest`);
         });
     }
+    /**
+     * Retrieves movies playing now asynchronously.
+     * @param {PageOption & LanguageOption & RegionOption} [options] - Optional parameters for specifying language, region, and pagination options.
+     * @returns {Promise<MoviesPlayingNow>} A Promise that resolves with the movies playing now.
+     */
     nowPlaying(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/now_playing`, options);
         });
     }
+    /**
+     * Retrieves popular movies asynchronously.
+     * @param {LanguageOption & PageOption} [options] - Optional parameters for specifying language and pagination options.
+     * @returns {Promise<PopularMovies>} A Promise that resolves with the popular movies.
+     */
     popular(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/popular`, options);
         });
     }
+    /**
+     * Retrieves top rated movies asynchronously.
+     * @param {PageOption & LanguageOption & RegionOption} [options] - Optional parameters for specifying language, region, and pagination options.
+     * @returns {Promise<TopRatedMovies>} A Promise that resolves with the top rated movies.
+     */
     topRated(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/top_rated`, options);
         });
     }
+    /**
+     * Retrieves upcoming movies asynchronously.
+     * @param {PageOption & LanguageOption & RegionOption} [options] - Optional parameters for specifying language, region, and pagination options.
+     * @returns {Promise<UpcomingMovies>} A Promise that resolves with the upcoming movies.
+     */
     upcoming(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_MOVIE}/upcoming`, options);

package/dist/endpoints/networks.d.ts

@@ -1,9 +1,31 @@
 import { AlternativeNames, BaseEndpoint, NetworkDetails, NetworkImages } from '@/@types';
+/**
+ * Represents an endpoint for accessing network details.
+ */
 export declare class NetworksEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new NetworksEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves details of a specific network asynchronously.
+     * @param {number} id - The ID of the network.
+     * @returns {Promise<NetworkDetails>} A Promise that resolves with the details of the network.
+     */
     details(id: number): Promise<NetworkDetails>;
+    /**
+     * Retrieves alternative names of a specific network asynchronously.
+     * @param {number} id - The ID of the network.
+     * @returns {Promise<AlternativeNames>} A Promise that resolves with the alternative names of the network.
+     */
     alternativeNames(id: number): Promise<AlternativeNames>;
+    /**
+     * Retrieves images of a specific network asynchronously.
+     * @param {number} id - The ID of the network.
+     * @returns {Promise<NetworkImages>} A Promise that resolves with the images of the network.
+     */
     images(id: number): Promise<NetworkImages>;
 }
 //# sourceMappingURL=networks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"networks.d.ts","sourceRoot":"","sources":["../../src/endpoints/networks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzF,qBAAa,gBAAiB,SAAQ,YAAY;IACpC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAI5C,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIvD,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAGjD"}
+{"version":3,"file":"networks.d.ts","sourceRoot":"","sources":["../../src/endpoints/networks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAKpC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAJnD;;;OAGG;gBAC4B,YAAY,EAAE,MAAM;IAInD;;;;OAIG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIlD;;;;OAIG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7D;;;;OAIG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAGjD"}

package/dist/endpoints/networks.js

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

package/dist/endpoints/people.d.ts

@@ -1,16 +1,84 @@
 import { AppendToResponse, AppendToResponsePersonKey, BaseEndpoint, ChangeOption, Changes, ExternalIds, LanguageOption, PageOption, PeopleImages, PersonChangeValue, PersonCombinedCredits, PersonDetails, PersonMovieCredit, PersonTranslations, PersonTvShowCredit, PopularPersons, TaggedImages } from '@/@types';
+/**
+ * Represents an endpoint for accessing information about people.
+ */
 export declare class PeopleEndpoint extends BaseEndpoint {
+    /**
+     * Constructs a new PeopleEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * 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<T extends AppendToResponsePersonKey[] | undefined>(id: number, appendToResponse?: T, language?: string): Promise<AppendToResponse<PersonDetails, T, "person">>;
+    /**
+     * 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: number, options?: ChangeOption): Promise<Changes<PersonChangeValue>>;
+    /**
+     * 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: number, options?: LanguageOption): Promise<PersonMovieCredit>;
+    /**
+     * 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: number, options?: LanguageOption): Promise<PersonTvShowCredit>;
+    /**
+     * 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: number, options?: LanguageOption): Promise<PersonCombinedCredits>;
+    /**
+     * 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: number): Promise<ExternalIds>;
+    /**
+     * 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: number): Promise<PeopleImages>;
+    /**
+     * 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: number, options?: PageOption): Promise<TaggedImages>;
+    /**
+     * 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: number): Promise<PersonTranslations>;
+    /**
+     * Retrieves details of the latest person asynchronously.
+     * @returns {Promise<PersonDetails>} A Promise that resolves with the details of the latest person.
+     */
     latest(): Promise<PersonDetails>;
+    /**
+     * 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?: LanguageOption & PageOption): Promise<PopularPersons>;
 }
 //# sourceMappingURL=people.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"people.d.ts","sourceRoot":"","sources":["../../src/endpoints/people.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,WAAW,EACX,cAAc,EACd,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,YAAY,EACb,MAAM,UAAU,CAAC;AAIlB,qBAAa,cAAe,SAAQ,YAAY;gBAClC,YAAY,EAAE,MAAM;IAI1B,OAAO,CAAC,CAAC,SAAS,yBAAyB,EAAE,GAAG,SAAS,EAC7D,EAAE,EAAE,MAAM,EACV,gBAAgB,CAAC,EAAE,CAAC,EACpB,QAAQ,CAAC,EAAE,MAAM;IASb,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAIhF,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9E,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIhF,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIrF,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI5C,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrE,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpD,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAIhC,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;CAG9E"}
+{"version":3,"file":"people.d.ts","sourceRoot":"","sources":["../../src/endpoints/people.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,WAAW,EACX,cAAc,EACd,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,YAAY,EACb,MAAM,UAAU,CAAC;AAIlB;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;;;OAMG;IACG,OAAO,CAAC,CAAC,SAAS,yBAAyB,EAAE,GAAG,SAAS,EAC7D,EAAE,EAAE,MAAM,EACV,gBAAgB,CAAC,EAAE,CAAC,EACpB,QAAQ,CAAC,EAAE,MAAM;IASnB;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAItF;;;;;OAKG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpF;;;;;OAKG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAItF;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI3F;;;;OAIG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIlD;;;;OAIG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAI/C;;;;;OAKG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAI3E;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI1D;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAItC;;;;OAIG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;CAG9E"}

package/dist/endpoints/people.js

@@ -12,10 +12,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PeopleEndpoint = void 0;
 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';
+/**
+ * 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

@@ -11,10 +11,22 @@ 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");
+/**
+ * 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