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

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

import type { PaginationParams } from '../models';
import type { ClubSearchParams } from '../models/clubs/clubs-params.model';
import type { Club, ClubMember, ClubRelations, ClubStaff } from '../models/clubs/clubs.model';
import { BaseClient } from './base.client';
/**
 * **Club Client**
 *
 * Client used to access the Club Endpoints.
 *
 * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
 */
export declare class ClubsClient extends BaseClient {
    /**
     * @returns Club resource
     * @param id Club ID
     */
    getClubsById(id: number): Promise<import("../models").JikanResponse<Club>>;
    /**
     * @returns Club members resource
     * @param id Club ID
     * @param params
     */
    getClubMembers(id: number, params?: Partial<PaginationParams>): Promise<import("../models").JikanResponse<ClubMember[]>>;
    /**
     * @returns Club staff
     * @param id Club ID
     */
    getClubStaff(id: number): Promise<import("../models").JikanResponse<ClubStaff[]>>;
    /**
     * @returns Club relations
     * @param id Club ID
     */
    getClubRelations(id: number): Promise<import("../models").JikanResponse<ClubRelations>>;
    /**
     * @returns Search results for Clubs
     * @param params
     */
    getClubSearch(params?: Partial<ClubSearchParams>): Promise<import("../models").JikanResponse<Club[]>>;
}