crunchyroll-js-api/dist/types/services/discover.d.ts

JavaScript API consumer for crunchyroll

declare namespace _default {
    export { getWatchlist };
    export { getBrowseAll };
    export { getBrowseIndex };
    export { getCategories };
    export { getSubcategories };
    export { getHome };
    export { getHomeFeed };
    export { getPersonalRecomendation };
    export { getHistory };
    export { getRecommendations };
    export { getSeasonList };
    export { getSimilar };
    export { getNext };
    export { getPrev };
    export { search };
    export { markAsWatched };
}
export default _default;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {Boolean} [obj.ratings]
 * @param {String} [obj.order] Order
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>}>}
 */
declare function getWatchlist({ account, quantity, start, ratings, order, fnConfig }: {
    account: import("../types").AccountAuth;
    quantity?: number;
    start?: number;
    ratings?: boolean;
    order?: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {Array<String>} [obj.category] Category
 * @param {String} [obj.query] Search pattern
 * @param {String} [obj.seasonTag] season tag
 * @param {String} [obj.sort] sort results
 * @param {String} [obj.type] type for search, example episode
 * @param {Boolean} [obj.ratings]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getBrowseAll({ account, quantity, start, category, query, seasonTag, sort, type, ratings, fnConfig }: {
    account: import("../types").AccountAuth;
    quantity?: number;
    start?: number;
    category?: Array<string>;
    query?: string;
    seasonTag?: string;
    sort?: string;
    type?: string;
    ratings?: boolean;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} [obj.category] Category
 * @param {String} [obj.sort] sort results
 * @param {Boolean} [obj.ratings]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getBrowseIndex({ account, category, sort, ratings, fnConfig }: {
    account: import("../types").AccountAuth;
    category?: Array<string>;
    sort?: string;
    ratings?: boolean;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.contentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getCategories({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} obj.parentCategory Offset to request
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getSubcategories({ account, parentCategory, fnConfig }: {
    account: import("../types").AccountAuth;
    parentCategory: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').HomeItem>}
 */
declare function getHome({ account, fnConfig }: {
    account: import("../types").AccountAuth;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").HomeItem>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<Object>}>}
 */
declare function getHomeFeed({ account, quantity, start, fnConfig }: {
    account: import("../types").AccountAuth;
    quantity?: number;
    start?: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<any>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.collectionId
 * @param {Boolean} obj.ratings
 * @param {String} [obj.vendor]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<import('../types').HomeItem>}
 */
declare function getPersonalRecomendation({ account, collectionId, ratings, vendor, fnConfig }: {
    account: import("../types").AccountAuth;
    collectionId: string;
    ratings: boolean;
    vendor?: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<import("../types").HomeItem>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} obj.quantity
 * @param {Boolean} obj.ratings
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getHistory({ account, quantity, ratings, fnConfig }: {
    account: import("../types").AccountAuth;
    quantity: number;
    ratings: boolean;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {Boolean} [obj.ratings]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getRecommendations({ account, quantity, start, ratings, fnConfig }: {
    account: import("../types").AccountAuth;
    quantity?: number;
    start?: number;
    ratings?: boolean;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{items: Array<{id: String, localization: Object}>}>}
 */
declare function getSeasonList({ account, fnConfig }: {
    account: import("../types").AccountAuth;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    items: Array<{
        id: string;
        localization: any;
    }>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} obj.contentId Offset to request
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {Boolean} [obj.ratings]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getSimilar({ account, contentId, quantity, start, ratings, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: number;
    quantity?: number;
    start?: number;
    ratings?: boolean;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.contentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getNext({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.contentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function getPrev({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.query search partner
 * @param {Number} [obj.quantity] Number of records in a result
 * @param {Number} [obj.start] Offset to request
 * @param {Array<String>} [obj.type] Can be top_results, series, movie_listing, episode
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
 */
declare function search({ account, query, quantity, start, type, fnConfig }: {
    account: import("../types").AccountAuth;
    query: string;
    quantity?: number;
    start?: number;
    type?: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: Array<any>;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} obj.contentId Offset to request
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function markAsWatched({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;