@tutkli/jikan-ts/dist/clients/characters.client.d.ts

Node.js wrapper for the Jikan API with built-in typings.

import type { Character, CharacterAnime, CharacterFull, CharacterManga, CharactersSearchParams, CharacterVoiceActor, JikanImagesCollection } from '../models';
import { BaseClient } from './base.client';
/**
 * **Characters Client**
 *
 * Client used to access the Character Endpoints:
 *
 * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
 */
export declare class CharactersClient extends BaseClient {
    /**
     * Get complete Character data
     * @param id The Character ID
     */
    getCharacterFullById(id: number): Promise<import("../models").JikanResponse<CharacterFull>>;
    /**
     * Get Character data
     * @param id The Character ID
     */
    getCharacterById(id: number): Promise<import("../models").JikanResponse<Character>>;
    /**
     * Get Character anime data
     * @param id The Character ID
     */
    getCharacterAnime(id: number): Promise<import("../models").JikanResponse<CharacterAnime[]>>;
    /**
     * Get Character manga data
     * @param id The Character ID
     */
    getCharacterManga(id: number): Promise<import("../models").JikanResponse<CharacterManga[]>>;
    /**
     * Get Character voices data
     * @param id The Character ID
     */
    getCharacterVoiceActors(id: number): Promise<import("../models").JikanResponse<CharacterVoiceActor[]>>;
    /**
     * Get Character pictures data
     * @param id The Character ID
     */
    getCharacterPictures(id: number): Promise<import("../models").JikanResponse<JikanImagesCollection[]>>;
    /**
     * Get all the Characters within the given filter. Returns all Characters if no filters are given.
     * @param searchParams Filter parameters
     */
    getCharacterSearch(searchParams: Partial<CharactersSearchParams>): Promise<import("../models").JikanResponse<Character[]>>;
}