@apihawk/help-center-sdk/lib/services/help-center-sdk-articles.d.ts

The ApiHawk Help Center SDK

import { HelpCenterSDKServiceBase } from '../lib/help-center-sdk-service-base';
import { IRestPaginatedResource } from '../types/common';
import { IContent2Category, IHelpCenterArticle } from './help-center-sdk.types';
export declare class HelpCenterSDKArticles extends HelpCenterSDKServiceBase {
    /**
     * Get articles
     * @param page
     * @param {number} pageSize
     * @param query
     * @returns {Promise<IRestPaginatedResource<IHelpCenterArticle>>}
     */
    getArticles(page?: number, pageSize?: number, query?: {
        id?: number | number[];
        seo_url?: string;
        columns?: string[];
    }): Promise<IRestPaginatedResource<IHelpCenterArticle>>;
    /**
     * Get article by seo_url
     * @returns {IHelpCenterArticle}
     * @param seoUrl
     */
    getArticleBySeoUrl(seoUrl: string): Promise<IHelpCenterArticle>;
    /**
     * Get article by id
     * @returns {IHelpCenterArticle}
     * @param id
     */
    getArticleById(id: number): Promise<IHelpCenterArticle>;
    /**
     * Get content2categories
     * @param {number} page
     * @param {number} pageSize
     * @param query
     * @returns {Promise<IRestPaginatedResource<IContent2Category>>}
     */
    getContent2categories(page?: number, pageSize?: number, query?: {
        contentId?: number | number[];
        categoryId?: number | number[];
        advanced?: boolean;
    }): Promise<IRestPaginatedResource<IContent2Category>>;
    /**
     * Get latest articles by category
     * @param {number[]} ids
     * @returns {Promise<any>}
     */
    getLatestByCategory(ids?: number[]): Promise<any>;
    /**
     * Get all latest articles
     * @param {number[]} ids
     * @returns {Promise<Bluebird<any>>}
     */
    getAllLatest(ids?: number[]): Promise<any>;
    /**
     *
     * @returns {IRestPaginatedResource<IHelpCenterArticle>}
     */
    getEmptyList(): IRestPaginatedResource<IHelpCenterArticle>;
}