@tdanks2000/tmdb-wrapper 1.0.0 → 1.0.1

package/dist/endpoints/configuration.d.ts

@@ -1,7 +1,18 @@
 import { BaseEndpoint, Configuration } from '@/@types';
+/**
+ * Represents an endpoint for retrieving current system configuration.
+ */
 export declare class ConfigurationEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new ConfigurationEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves the current system configuration asynchronously.
+     * @returns {Promise<Configuration>} A Promise that resolves with the current system configuration.
+     */
     getCurrent(): Promise<Configuration>;
 }
 //# sourceMappingURL=configuration.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../../src/endpoints/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEvD,qBAAa,qBAAsB,SAAQ,YAAY;IACzC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC;CAG3C"}
+{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../../src/endpoints/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEvD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAKzC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAJnD;;;OAGG;gBAC4B,YAAY,EAAE,MAAM;IAInD;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC;CAG3C"}

package/dist/endpoints/configuration.js

@@ -11,11 +11,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationEndpoint = void 0;
 const _types_1 = require("@/@types");
+/**
+ * Represents an endpoint for retrieving current system configuration.
+ */
 class ConfigurationEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new ConfigurationEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
         this.access_token = access_token;
     }
+    /**
+     * Retrieves the current system configuration asynchronously.
+     * @returns {Promise<Configuration>} A Promise that resolves with the current system configuration.
+     */
     getCurrent() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`/configuration`);

package/dist/endpoints/credits.d.ts

@@ -1,7 +1,19 @@
 import { BaseEndpoint, CreditResponse } from '@/@types';
+/**
+ * Represents an endpoint for retrieving credit details.
+ */
 export declare class CreditsEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new CreditsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves credit details by ID asynchronously.
+     * @param {string} id - The ID of the credit.
+     * @returns {Promise<CreditResponse>} A Promise that resolves with the credit details.
+     */
     getById(id: string): Promise<CreditResponse>;
 }
 //# sourceMappingURL=credits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../src/endpoints/credits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAExD,qBAAa,eAAgB,SAAQ,YAAY;IACnC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;CAGnD"}
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../src/endpoints/credits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAExD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAKnC,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;CAGnD"}

package/dist/endpoints/credits.js

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

package/dist/endpoints/discover.d.ts

@@ -1,61 +1,24 @@
-import { BaseEndpoint, MovieDiscoverResult, SortOption, TvShowDiscoverResult } from '@/@types';
-interface DiscoverQueryOptions {
-    language?: string;
-    sort_by?: SortOption;
-    page?: number;
-    'vote_average.gte'?: number;
-    'vote_count.gte'?: number;
-    'vote_count.lte'?: number;
-    'vote_average.lte'?: number;
-    with_watch_providers?: string;
-    watch_region?: string;
-    without_companies?: string;
-    with_watch_monetization_types?: 'flatrate' | 'free' | 'ads' | 'rent' | 'buy';
-    'with_runtime.gte'?: number;
-    'with_runtime.lte'?: number;
-    with_genres?: string;
-    without_genres?: string;
-    with_original_language?: string;
-    without_keywords?: string;
-    with_keywords?: string;
-    with_companies?: string;
-}
-interface MovieQueryOptions extends DiscoverQueryOptions {
-    region?: string;
-    certification_country?: string;
-    certification?: string;
-    'certification.lte'?: string;
-    'certification.gte'?: string;
-    include_adult?: boolean;
-    include_video?: boolean;
-    primary_release_year?: number;
-    'primary_release_date.gte'?: string;
-    'primary_release_date.lte'?: string;
-    'release_date.gte'?: string;
-    'release_date.lte'?: string;
-    with_release_type?: string;
-    year?: number;
-    with_cast?: string;
-    with_crew?: string;
-    with_people?: string;
-}
-interface TvShowQueryOptions extends DiscoverQueryOptions {
-    'air_date.gte'?: string;
-    'air_date.lte'?: string;
-    'first_air_date.gte'?: string;
-    'first_air_date.lte'?: string;
-    first_air_date_year?: number;
-    timezone?: string;
-    with_networks?: string;
-    include_null_first_air_dates?: boolean;
-    screened_theatrically?: boolean;
-    with_status?: string;
-    with_type?: string;
-}
+import { BaseEndpoint, MovieDiscoverResult, MovieQueryOptions, TvShowDiscoverResult, TvShowQueryOptions } from '@/@types';
+/**
+ * Represents an endpoint for discovering movies and TV shows based on various criteria.
+ */
 export declare class DiscoverEndpoint extends BaseEndpoint {
+    /**
+     * Constructs a new DiscoverEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves a list of movies based on the provided query options asynchronously.
+     * @param {MovieQueryOptions} [options] - Optional parameters for refining the movie discovery.
+     * @returns {Promise<MovieDiscoverResult>} A Promise that resolves with the movie discovery results.
+     */
     movie(options?: MovieQueryOptions): Promise<MovieDiscoverResult>;
+    /**
+     * Retrieves a list of TV shows based on the provided query options asynchronously.
+     * @param {TvShowQueryOptions} [options] - Optional parameters for refining the TV show discovery.
+     * @returns {Promise<TvShowDiscoverResult>} A Promise that resolves with the TV show discovery results.
+     */
     tvShow(options?: TvShowQueryOptions): Promise<TvShowDiscoverResult>;
 }
-export {};
 //# sourceMappingURL=discover.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../src/endpoints/discover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAI/F,UAAU,oBAAoB;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6BAA6B,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;IAC7E,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,UAAU,iBAAkB,SAAQ,oBAAoB;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,kBAAmB,SAAQ,oBAAoB;IACvD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,gBAAiB,SAAQ,YAAY;gBACpC,YAAY,EAAE,MAAM;IAI1B,KAAK,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIhE,MAAM,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG1E"}
+{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../src/endpoints/discover.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,UAAU,CAAC;AAIlB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;OAIG;IACG,KAAK,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAItE;;;;OAIG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG1E"}

package/dist/endpoints/discover.js

@@ -12,15 +12,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DiscoverEndpoint = void 0;
 const _types_1 = require("@/@types");
 const BASE_DISCOVER = '/discover';
+/**
+ * Represents an endpoint for discovering movies and TV shows based on various criteria.
+ */
 class DiscoverEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new DiscoverEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves a list of movies based on the provided query options asynchronously.
+     * @param {MovieQueryOptions} [options] - Optional parameters for refining the movie discovery.
+     * @returns {Promise<MovieDiscoverResult>} A Promise that resolves with the movie discovery results.
+     */
     movie(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_DISCOVER}/movie`, options);
         });
     }
+    /**
+     * Retrieves a list of TV shows based on the provided query options asynchronously.
+     * @param {TvShowQueryOptions} [options] - Optional parameters for refining the TV show discovery.
+     * @returns {Promise<TvShowDiscoverResult>} A Promise that resolves with the TV show discovery results.
+     */
     tvShow(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`${BASE_DISCOVER}/tv`, options);

package/dist/endpoints/find.d.ts

@@ -1,6 +1,19 @@
 import { BaseEndpoint, ExternalIdOptions, FindResult } from '@/@types';
+/**
+ * Represents an endpoint for finding media by external ID.
+ */
 export declare class FindEndpoint extends BaseEndpoint {
+    /**
+     * Constructs a new FindEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves media by external ID asynchronously.
+     * @param {string} externalId - The external ID of the media.
+     * @param {ExternalIdOptions} options - Options for finding media by external ID.
+     * @returns {Promise<FindResult>} A Promise that resolves with the result of the find operation.
+     */
     byId(externalId: string, options: ExternalIdOptions): Promise<FindResult>;
 }
 //# sourceMappingURL=find.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../src/endpoints/find.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEvE,qBAAa,YAAa,SAAQ,YAAY;gBAChC,YAAY,EAAE,MAAM;IAI1B,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;CAGhF"}
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../src/endpoints/find.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEvE;;GAEG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;;OAKG;IACG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;CAGhF"}

package/dist/endpoints/find.js

@@ -11,10 +11,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FindEndpoint = void 0;
 const _types_1 = require("@/@types");
+/**
+ * Represents an endpoint for finding media by external ID.
+ */
 class FindEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new FindEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves media by external ID asynchronously.
+     * @param {string} externalId - The external ID of the media.
+     * @param {ExternalIdOptions} options - Options for finding media by external ID.
+     * @returns {Promise<FindResult>} A Promise that resolves with the result of the find operation.
+     */
     byId(externalId, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get(`/find/${externalId}`, options);

package/dist/endpoints/genre.d.ts

@@ -1,14 +1,25 @@
-import { BaseEndpoint, LanguageOption } from '@/@types';
-export interface Genres {
-    genres: Array<{
-        id: number;
-        name: string;
-    }>;
-}
+import { BaseEndpoint, Genres, LanguageOption } from '@/@types';
+/**
+ * Represents an endpoint for retrieving genre information for movies and TV shows.
+ */
 export declare class GenreEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new GenreEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves genre information for movies asynchronously.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Genres>} A Promise that resolves with the genre information for movies.
+     */
     movies(options?: LanguageOption): Promise<Genres>;
+    /**
+     * Retrieves genre information for TV shows asynchronously.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Genres>} A Promise that resolves with the genre information for TV shows.
+     */
     tv(options?: LanguageOption): Promise<Genres>;
 }
 //# sourceMappingURL=genre.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"genre.d.ts","sourceRoot":"","sources":["../../src/endpoints/genre.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAExD,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7C;AAED,qBAAa,aAAc,SAAQ,YAAY;IACjC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAIjD,EAAE,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;CAGpD"}
+{"version":3,"file":"genre.d.ts","sourceRoot":"","sources":["../../src/endpoints/genre.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAKjC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAJnD;;;OAGG;gBAC4B,YAAY,EAAE,MAAM;IAInD;;;;OAIG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvD;;;;OAIG;IACG,EAAE,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;CAGpD"}

package/dist/endpoints/genre.js

@@ -11,16 +11,33 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenreEndpoint = void 0;
 const _types_1 = require("@/@types");
+/**
+ * Represents an endpoint for retrieving genre information for movies and TV shows.
+ */
 class GenreEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new GenreEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
         this.access_token = access_token;
     }
+    /**
+     * Retrieves genre information for movies asynchronously.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Genres>} A Promise that resolves with the genre information for movies.
+     */
     movies(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get('/genre/movie/list', options);
         });
     }
+    /**
+     * Retrieves genre information for TV shows asynchronously.
+     * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+     * @returns {Promise<Genres>} A Promise that resolves with the genre information for TV shows.
+     */
     tv(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.get('/genre/tv/list', options);

package/dist/endpoints/keywords.d.ts

@@ -1,7 +1,25 @@
 import { BaseEndpoint, BelongingMovies, Keyword, KeywordsOptions } from '@/@types';
+/**
+ * Represents an endpoint for accessing keyword details and related movies.
+ */
 export declare class KeywordsEndpoint extends BaseEndpoint {
+    /**
+     * Constructs a new KeywordsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * Retrieves details of a specific keyword asynchronously.
+     * @param {number} keywordId - The ID of the keyword.
+     * @returns {Promise<Keyword>} A Promise that resolves with the details of the keyword.
+     */
     details(keywordId: number): Promise<Keyword>;
+    /**
+     * Retrieves movies belonging to a specific keyword asynchronously.
+     * @param {number} keywordId - The ID of the keyword.
+     * @param {KeywordsOptions} [options] - Optional parameters for refining the search.
+     * @returns {Promise<BelongingMovies>} A Promise that resolves with the movies belonging to the keyword.
+     */
     belongingMovies(keywordId: number, options?: KeywordsOptions): Promise<BelongingMovies>;
 }
 //# sourceMappingURL=keywords.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../src/endpoints/keywords.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAInF,qBAAa,gBAAiB,SAAQ,YAAY;gBACpC,YAAY,EAAE,MAAM;IAI1B,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5C,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAG9F"}
+{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../src/endpoints/keywords.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAInF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;OAGG;gBACS,YAAY,EAAE,MAAM;IAIhC;;;;OAIG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlD;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAG9F"}

package/dist/endpoints/keywords.js

@@ -11,19 +11,37 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeywordsEndpoint = void 0;
 const _types_1 = require("@/@types");
-const BASE_Keyword = '/keyword';
+const BASE_KEYWORD = '/keyword';
+/**
+ * Represents an endpoint for accessing keyword details and related movies.
+ */
 class KeywordsEndpoint extends _types_1.BaseEndpoint {
+    /**
+     * Constructs a new KeywordsEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token) {
         super(access_token);
     }
+    /**
+     * Retrieves details of a specific keyword asynchronously.
+     * @param {number} keywordId - The ID of the keyword.
+     * @returns {Promise<Keyword>} A Promise that resolves with the details of the keyword.
+     */
     details(keywordId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.get(`${BASE_Keyword}/${keywordId}`);
+            return yield this.api.get(`${BASE_KEYWORD}/${keywordId}`);
         });
     }
+    /**
+     * Retrieves movies belonging to a specific keyword asynchronously.
+     * @param {number} keywordId - The ID of the keyword.
+     * @param {KeywordsOptions} [options] - Optional parameters for refining the search.
+     * @returns {Promise<BelongingMovies>} A Promise that resolves with the movies belonging to the keyword.
+     */
     belongingMovies(keywordId, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.get(`${BASE_Keyword}/${keywordId}/movies`, options);
+            return yield this.api.get(`${BASE_KEYWORD}/${keywordId}/movies`, options);
         });
     }
 }

package/dist/endpoints/movies.d.ts

@@ -1,36 +1,142 @@
-import { AlternativeTitles, AppendToResponse, AppendToResponseMovieKey, BaseEndpoint, ChangeOption, Changes, Credits, ExternalIds, Images, Keywords, LanguageOption, LatestMovie, MovieChangeValue, MovieDetails, MovieLists, MoviesPlayingNow, PageOption, PopularMovies, Recommendations, RegionOption, ReleaseDates, Reviews, SimilarMovies, TopRatedMovies, Translations, UpcomingMovies, Videos, WatchProviders } from '@/@types';
-export interface MoviesImageSearchOptions extends LanguageOption {
-    /**
-     * a list of ISO-639-1 values to query
-     */
-    include_image_language?: string[];
-}
+import { AlternativeTitles, AppendToResponse, AppendToResponseMovieKey, BaseEndpoint, ChangeOption, Changes, Credits, ExternalIds, Images, Keywords, LanguageOption, LatestMovie, MovieChangeValue, MovieDetails, MovieLists, MoviesImageSearchOptions, MoviesPlayingNow, PageOption, PopularMovies, Recommendations, RegionOption, ReleaseDates, Reviews, SimilarMovies, TopRatedMovies, Translations, UpcomingMovies, Videos, WatchProviders } from '@/@types';
+/**
+ * Represents an endpoint for accessing movie-related information.
+ */
 export declare class MoviesEndpoint extends BaseEndpoint {
     protected readonly access_token: string;
+    /**
+     * Constructs a new MoviesEndpoint instance.
+     * @param {string} access_token - The access token used for authentication.
+     */
     constructor(access_token: string);
+    /**
+     * 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<T extends AppendToResponseMovieKey[] | undefined>(id: number, appendToResponse?: T, language?: string): Promise<AppendToResponse<MovieDetails, T, "movie">>;
+    /**
+     * 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: number): Promise<AlternativeTitles>;
+    /**
+     * 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: number, options?: ChangeOption): Promise<Changes<MovieChangeValue>>;
+    /**
+     * 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: number, options?: LanguageOption): Promise<Credits>;
+    /**
+     * 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: number): Promise<ExternalIds>;
+    /**
+     * 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: number, options?: MoviesImageSearchOptions): Promise<Images>;
+    /**
+     * 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: number): Promise<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: number, options?: LanguageOption & PageOption): Promise<MovieLists>;
+    /**
+     * 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: number, options?: LanguageOption & PageOption): Promise<Recommendations>;
+    /**
+     * 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: number): Promise<ReleaseDates>;
+    /**
+     * 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: number, options?: LanguageOption & PageOption): Promise<Reviews>;
+    /**
+     * 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: number, options?: LanguageOption & PageOption): Promise<SimilarMovies>;
+    /**
+     * 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: number): Promise<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: number, options?: LanguageOption): Promise<Videos>;
     /**
-     * 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: number): Promise<WatchProviders>;
+    /**
+     * Retrieves details of the latest movie asynchronously.
+     * @returns {Promise<LatestMovie>} A Promise that resolves with the details of the latest movie.
+     */
     latest(): Promise<LatestMovie>;
+    /**
+     * 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?: PageOption & LanguageOption & RegionOption): Promise<MoviesPlayingNow>;
+    /**
+     * 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?: LanguageOption & PageOption): Promise<PopularMovies>;
+    /**
+     * 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?: PageOption & LanguageOption & RegionOption): Promise<TopRatedMovies>;
+    /**
+     * 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?: PageOption & LanguageOption & RegionOption): Promise<UpcomingMovies>;
 }
 //# sourceMappingURL=movies.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"movies.d.ts","sourceRoot":"","sources":["../../src/endpoints/movies.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,wBAAwB,EACxB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,WAAW,EACX,MAAM,EACN,QAAQ,EACR,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,EACd,MAAM,EACN,cAAc,EACf,MAAM,UAAU,CAAC;AAIlB,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC9D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,qBAAa,cAAe,SAAQ,YAAY;IAClC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM;IAI7C,OAAO,CAAC,CAAC,SAAS,wBAAwB,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM;IAS7G,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIzD,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAI/E,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI7C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQvE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAI7E,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5F,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAI/C,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5E,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlF,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAI/C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAInE;;;OAGG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAInD,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;IAI9B,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3F,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAItE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAIvF,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;CAG9F"}
+{"version":3,"file":"movies.d.ts","sourceRoot":"","sources":["../../src/endpoints/movies.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,wBAAwB,EACxB,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,WAAW,EACX,MAAM,EACN,QAAQ,EACR,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,wBAAwB,EACxB,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,EACd,MAAM,EACN,cAAc,EACf,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;;;;;;OAMG;IACG,OAAO,CAAC,CAAC,SAAS,wBAAwB,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM;IASnH;;;;OAIG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/D;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAIrF;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrE;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInD;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ7E;;;;OAIG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI7C;;;;;OAKG;IACG,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAInF;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlG;;;;OAIG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrD;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAIxF;;;;OAIG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrD;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAInE;;;;OAIG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzD;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;IAIpC;;;;OAIG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIjG;;;;OAIG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAI5E;;;;OAIG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAI7F;;;;OAIG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;CAG9F"}