@odyssoft/tmdb/lib/people.d.ts

Unofficial TMDB v3 api wrapper, built using TypeScript and node.js

import * as Types from './types';
export declare const People: (apiKey: string) => {
    /**
     * Query the top level details of a person.
     * @param {number} person_id
     * @param {object} options
     * @returns Prmoise<PersonDetails>
     */
    GetDetails: (person_id: number, options?: Types.AppendOptions<Types.PersonAppend>) => Promise<Types.PersonDetails>;
    /**
     * Get the recent changes for a person.
     * @param {number} person_id
     * @param {object} options
     * @returns Promise<PersonChanges>
     */
    GetChanges: (person_id: number, options?: Types.PersonChangesOptions) => Promise<Types.PersonChanges>;
    /**
     * Get the combined movie and TV credits that belong to a person.
     * @param {number} person_id
     * @param {object} options
     * @returns Promise<PersonCombinedCredits>
     */
    GetCombinedCredits: (person_id: number, options?: Types.Options) => Promise<Types.PersonCombinedCredits>;
    /**
     * Get the external ID's that belong to a person.
     * @param {number} person_id
     * @returns Promise<PersonExternalIds>
     */
    GetExternalIds: (person_id: number) => Promise<Types.PersonExternalIds>;
    /**
     * Get the profile images that belong to a person.
     * @param {number} person_id
     * @returns Promise<PersonImages>
     */
    GetImages: (person_id: number) => Promise<Types.PersonImages>;
    /**
     * Get the newest created person. This is a live response and will continuously change.#
     * @returns Promise<PersonDetails>
     */
    GetLatest: () => Promise<Types.PersonDetails>;
    /**
     * Get the movie credits for a person.
     * @param {number} person_id
     * @param {object} options
     * @returns Promise<PersonMovieCredits>
     */
    GetMovieCredits: (person_id: number, options?: Types.PageOptions) => Promise<Types.PersonMovieCredits>;
    /**
     * Get the TV credits that belong to a person.
     * @param {number} person_id
     * @param {object} options
     * @returns Promise<PersonTVCredits>
     */
    GetTVCredits: (person_id: number, options?: Types.PageOptions) => Promise<Types.PersonTVCredits>;
};
export default People;