intercom-client
Version:
Official Node bindings to the Intercom API
49 lines (48 loc) • 1.8 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";
export declare namespace SegmentsClient {
interface Options extends BaseClientOptions {
}
interface RequestOptions extends BaseRequestOptions {
}
}
/**
* Everything about your Segments
*/
export declare class SegmentsClient {
protected readonly _options: NormalizedClientOptionsWithAuth<SegmentsClient.Options>;
constructor(options?: SegmentsClient.Options);
/**
* You can fetch a list of all segments.
*
* @param {Intercom.ListSegmentsRequest} request
* @param {SegmentsClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
*
* @example
* await client.segments.list({
* include_count: true
* })
*/
list(request?: Intercom.ListSegmentsRequest, requestOptions?: SegmentsClient.RequestOptions): core.HttpResponsePromise<Intercom.SegmentList>;
private __list;
/**
* You can fetch the details of a single segment.
*
* @param {Intercom.FindSegmentRequest} request
* @param {SegmentsClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
* @throws {@link Intercom.NotFoundError}
*
* @example
* await client.segments.find({
* segment_id: "123"
* })
*/
find(request: Intercom.FindSegmentRequest, requestOptions?: SegmentsClient.RequestOptions): core.HttpResponsePromise<Intercom.Segment>;
private __find;
}