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

JavaScript API consumer for crunchyroll

declare namespace _default {
    export { addItemToCustomList };
    export { addWatchlistItem };
    export { changeCustomListItemPosition };
    export { createPrivateCustomList };
    export { deleteCustomListItem };
    export { deletePrivateCustomList };
    export { deleteWatchlistItem };
    export { getCustomListItems };
    export { getCustomLists };
    export { getData };
    export { getPlayheads };
    export { getWatchHistory };
    export { getWatchlistItems };
    export { savePlayhead };
    export { updateCustomList };
    export { updateWatchlistItemFavoriteStatus };
}
export default _default;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.listId
 * @param {String} obj.contentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function addItemToCustomList({ account, listId, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    listId: string;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<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}
 */
declare function addWatchlistItem({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.listId
 * @param {String} obj.contentId
 * @param {String} obj.location
 * @param {String} obj.refContentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function changeCustomListItemPosition({ account, listId, contentId, location, refContentId, fnConfig }: {
    account: import("../types").AccountAuth;
    listId: string;
    contentId: string;
    location: string;
    refContentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.title
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{data: Array<import('../types').CustomListResponse>}>}
 */
declare function createPrivateCustomList({ account, title, fnConfig }: {
    account: import("../types").AccountAuth;
    title: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    data: Array<import("../types").CustomListResponse>;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.listId
 * @param {String} obj.contentId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function deleteCustomListItem({ account, listId, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    listId: string;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.listId
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function deletePrivateCustomList({ account, listId, fnConfig }: {
    account: import("../types").AccountAuth;
    listId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<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}
 */
declare function deleteWatchlistItem({ account, contentId, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.listId
 * @param {String} [obj.page]
 * @param {String} [obj.pageSize]
 * @param {String} [obj.sort] manual, date_added
 * @param {String} [obj.order] asc, desc
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getCustomListItems({ account, listId, page, pageSize, sort, order, fnConfig }: {
    account: import("../types").AccountAuth;
    listId: string;
    page?: string;
    pageSize?: string;
    sort?: string;
    order?: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<{total: Number, data: Object, meta: Object}>}
 */
declare function getCustomLists({ account, fnConfig }: {
    account: import("../types").AccountAuth;
    fnConfig?: import("../types").FetchConfig;
}): Promise<{
    total: number;
    data: any;
    meta: any;
}>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.method http method
 * @param {Boolean} [obj.baseUrlIncluded]
 * @param {String} obj.url if url incluse a domain pass baseUrlIncluded=true
 * @param {Object} [obj.body]
 * @param {Object} [obj.headers]
 * @param {Object} [obj.queryParams]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getData({ account, method, baseUrlIncluded, url, body, headers, queryParams, fnConfig, }: {
    account: import("../types").AccountAuth;
    method: string;
    baseUrlIncluded?: boolean;
    url: string;
    body?: any;
    headers?: any;
    queryParams?: any;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} obj.contentIds
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getPlayheads({ account, contentIds, fnConfig }: {
    account: import("../types").AccountAuth;
    contentIds: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Number} obj.page it has to be > 1
 * @param {Number} obj.pageSize
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getWatchHistory({ account, page, pageSize, fnConfig }: {
    account: import("../types").AccountAuth;
    page: number;
    pageSize: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {Array<String>} [obj.contentIds]
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise<Object>}
 */
declare function getWatchlistItems({ account, contentIds, fnConfig }: {
    account: import("../types").AccountAuth;
    contentIds?: Array<string>;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.contentId
 * @param {Number} obj.playhead
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function savePlayhead({ account, contentId, playhead, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    playhead: number;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.listId
 * @param {String} obj.title
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function updateCustomList({ account, listId, title, fnConfig }: {
    account: import("../types").AccountAuth;
    listId: string;
    title: string;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
 * @param {Object} obj
 * @param {import('../types').AccountAuth} obj.account
 * @param {String} obj.contentId
 * @param {Boolean} obj.isFavorite
 * @param {import('../types').FetchConfig} [obj.fnConfig]  util config param
 * @returns {Promise}
 */
declare function updateWatchlistItemFavoriteStatus({ account, contentId, isFavorite, fnConfig }: {
    account: import("../types").AccountAuth;
    contentId: string;
    isFavorite: boolean;
    fnConfig?: import("../types").FetchConfig;
}): Promise<any>;