intercom-client
Version:
Official Node bindings to the Intercom API
46 lines (45 loc) • 1.68 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 TeamsClient {
interface Options extends BaseClientOptions {
}
interface RequestOptions extends BaseRequestOptions {
}
}
/**
* Everything about your Teams
*/
export declare class TeamsClient {
protected readonly _options: NormalizedClientOptionsWithAuth<TeamsClient.Options>;
constructor(options?: TeamsClient.Options);
/**
* This will return a list of team objects for the App.
*
* @param {TeamsClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
*
* @example
* await client.teams.list()
*/
list(requestOptions?: TeamsClient.RequestOptions): core.HttpResponsePromise<Intercom.TeamList>;
private __list;
/**
* You can fetch the details of a single team, containing an array of admins that belong to this team.
*
* @param {Intercom.FindTeamRequest} request
* @param {TeamsClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
* @throws {@link Intercom.NotFoundError}
*
* @example
* await client.teams.find({
* team_id: "123"
* })
*/
find(request: Intercom.FindTeamRequest, requestOptions?: TeamsClient.RequestOptions): core.HttpResponsePromise<Intercom.Team>;
private __find;
}