intercom-client
Version:
Official Node bindings to the Intercom API
46 lines (45 loc) • 2.09 kB
TypeScript
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
import * as core from "../../../../core/index.js";
import * as Intercom from "../../../index.js";
import { CollectionsClient } from "../resources/collections/client/Client.js";
export declare namespace HelpCentersClient {
interface Options extends BaseClientOptions {
}
interface RequestOptions extends BaseRequestOptions {
}
}
export declare class HelpCentersClient {
protected readonly _options: NormalizedClientOptionsWithAuth<HelpCentersClient.Options>;
protected _collections: CollectionsClient | undefined;
constructor(options?: HelpCentersClient.Options);
get collections(): CollectionsClient;
/**
* You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/<id>`.
*
* @param {Intercom.FindHelpCenterRequest} request
* @param {HelpCentersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
* @throws {@link Intercom.NotFoundError}
*
* @example
* await client.helpCenters.find({
* help_center_id: 1
* })
*/
find(request: Intercom.FindHelpCenterRequest, requestOptions?: HelpCentersClient.RequestOptions): core.HttpResponsePromise<Intercom.HelpCenter>;
private __find;
/**
* You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.
*
* @param {Intercom.ListHelpCentersRequest} request
* @param {HelpCentersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
*
* @example
* await client.helpCenters.list()
*/
list(request?: Intercom.ListHelpCentersRequest, requestOptions?: HelpCentersClient.RequestOptions): Promise<core.Page<Intercom.HelpCenter, Intercom.HelpCenterList>>;
}