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

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

import type { CommonCharacter, ForumFilter, JikanExternalLink, JikanForum, JikanImages, JikanMoreInfo, JikanNews, JikanRelation, Manga, MangaReview, MangaSearchParams, MangaStatistics, MangaUserUpdate, Recommendation, ReviewsParams } from '../models';
import { BaseClient } from './base.client';
/**
 * **Manga Client**
 *
 * Client used to access the Manga Endpoints:
 *
 * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
 */
export declare class MangaClient extends BaseClient {
    /**
     * Get a Manga with full information by its ID
     * @param id The Manga ID
     */
    getMangaFullById(id: number): Promise<import("../models").JikanResponse<Manga>>;
    /**
     * Get a Manga by its ID
     * @param id The Manga ID
     */
    getMangaById(id: number): Promise<import("../models").JikanResponse<Manga>>;
    /**
     * Get Characters of a specific Manga
     * @param id The Manga ID
     */
    getMangaCharacters(id: number): Promise<import("../models").JikanResponse<CommonCharacter[]>>;
    /**
     * Get a list of manga news
     * @param id The Manga ID
     */
    getMangaNews(id: number): Promise<import("../models").JikanResponse<JikanNews[]>>;
    /**
     * Get a list og manga forum topics
     * @param id The manga ID
     * @param filter Filter topics
     */
    getMangaTopics(id: number, filter?: ForumFilter): Promise<import("../models").JikanResponse<JikanForum[]>>;
    /**
     * Get Pictures related to a specific Manga
     * @param id The Manga ID
     */
    getMangaPictures(id: number): Promise<import("../models").JikanResponse<JikanImages[]>>;
    /**
     * Get Statistics related to a specific Manga
     * @param id The Manga ID
     */
    getMangaStatistics(id: number): Promise<import("../models").JikanResponse<MangaStatistics>>;
    /**
     * Get more info related to the manga
     * @param id manga id
     */
    getMangaMoreInfo(id: number): Promise<import("../models").JikanResponse<JikanMoreInfo>>;
    /**
     * Get Recommendations related to a specific Manga
     * @param id The Manga ID
     */
    getMangaRecommendations(id: number): Promise<import("../models").JikanResponse<Recommendation[]>>;
    /**
     * Get anime Relations
     * @param id manga id
     */
    getMangaRelations(id: number): Promise<import("../models").JikanResponse<JikanRelation[]>>;
    /**
     * Get manga external links
     * @param id manga id
     */
    getMangaExternal(id: number): Promise<import("../models").JikanResponse<JikanExternalLink[]>>;
    /**
     * Get user updates for the manga
     * @param id manga id
     * @param page page number
     */
    getMangaUserUpdates(id: number, page?: number): Promise<import("../models").JikanResponse<MangaUserUpdate[]>>;
    /**
     * Get reviews for the manga
     * @param id manga id
     * @param params review parameters
     */
    getMangaReviews(id: number, params?: Partial<ReviewsParams>): Promise<import("../models").JikanResponse<MangaReview[]>>;
    /**
     * Get all the filtered Mangas. Returns all the Mangas if no filters are given.
     * @param searchParams Filter parameters
     */
    getMangaSearch(searchParams?: Partial<MangaSearchParams>): Promise<import("../models").JikanResponse<Manga[]>>;
}