@apihawk/help-center-sdk
Version:
The ApiHawk Help Center SDK
26 lines (25 loc) • 1.09 kB
TypeScript
import { ApiHawkConnectorService } from '@apihawk/connector';
import { HelpCenterSDKServiceBase } from '../lib/help-center-sdk-service-base';
import { IRestPaginatedResource } from '../types/common';
import { IHelpCenterArticlesByTags, IHelpCenterTag } from './help-center-sdk.types';
export declare class HelpCenterSDKTags extends HelpCenterSDKServiceBase {
private helpCenterSDKCategories;
constructor(api: ApiHawkConnectorService);
/**
* Get tags
* @param {number} page
* @param {number} pageSize
* @param {string} tag
* @returns {Promise<IRestPaginatedResource<IHelpCenterTag>>}
*/
getTags(page?: number, pageSize?: number, tag?: string): Promise<IRestPaginatedResource<IHelpCenterTag>>;
/**
* Get articles by tag
* @param {string} tag
* @param {string} rootCategory
* @param {number} page
* @param {number} pageSize
* @returns {Promise<IHelpCenterArticlesByTags>}
*/
getArticlesByTag(tag: string, rootCategory: string, page?: number, pageSize?: number): Promise<IHelpCenterArticlesByTags>;
}