@licht-77/dmm-sdk/dist/cjs/types/authorsearch.d.ts

DMM Affiliate API v3 SDK for Node.js/TypeScript

/**
 * 作者検索API (AuthorSearch) のリクエストパラメータ
 * https://affiliate.dmm.com/api/v3/authorsearch.html
 */
export interface AuthorSearchRequestParams {
    /** フロアID */
    floor_id: string;
    /** 頭文字 (50音) */
    initial?: string;
    /** ヒット件数 (1-1000, デフォルト: 100) */
    hits?: number;
    /** 検索開始位置 (1-, デフォルト: 1) */
    offset?: number;
    /** 出力オプション */
    output?: string;
}
/**
 * 作者情報
 */
export interface Author {
    /** 作者ID */
    author_id: string;
    /** 作者名 */
    name: string;
    /** フリガナ */
    ruby: string;
    /** リスト表示フラグ */
    list: number;
}
/**
 * 作者検索API (AuthorSearch) のレスポンス
 */
export interface AuthorSearchResponse {
    /** 総件数 */
    result_count: number;
    /** 取得件数 */
    total_count: number;
    /** 検索開始位置 */
    first_position: number;
    /** 作者リスト */
    author?: Author[];
}
//# sourceMappingURL=authorsearch.d.ts.map