intercom-client
Version:
Official Node bindings to the Intercom API
57 lines (56 loc) • 2.54 kB
text/typescript
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
import * as core from "../../../../core/index.mjs";
import * as Intercom from "../../../index.mjs";
export declare namespace IpAllowlistClient {
interface Options extends BaseClientOptions {
}
interface RequestOptions extends BaseRequestOptions {
}
}
/**
* Manage IP allowlist settings for your workspace.
*
* The IP Allowlist API allows you to configure which IP addresses are allowed to access the Intercom API and web application for your workspace. This is useful for restricting access to your Intercom workspace to specific corporate networks or VPNs.
*
* {% admonition type="info" name="Authentication" %}
* This endpoint requires the `manage_ip_allowlist` OAuth scope.
* {% /admonition %}
*/
export declare class IpAllowlistClient {
protected readonly _options: NormalizedClientOptionsWithAuth<IpAllowlistClient.Options>;
constructor(options?: IpAllowlistClient.Options);
/**
* Retrieve the current IP allowlist configuration for the workspace.
*
* @param {IpAllowlistClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
*
* @example
* await client.ipAllowlist.getIpAllowlist()
*/
getIpAllowlist(requestOptions?: IpAllowlistClient.RequestOptions): core.HttpResponsePromise<Intercom.IpAllowlist>;
private __getIpAllowlist;
/**
* Update the IP allowlist configuration for the workspace.
*
* {% admonition type="warning" name="Lockout Protection" %}
* The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.
* {% /admonition %}
*
* @param {Intercom.IpAllowlist} request
* @param {IpAllowlistClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.UnauthorizedError}
* @throws {@link Intercom.UnprocessableEntityError}
*
* @example
* await client.ipAllowlist.updateIpAllowlist({
* enabled: true,
* ip_allowlist: ["192.168.1.0/24", "10.0.0.1"]
* })
*/
updateIpAllowlist(request: Intercom.IpAllowlist, requestOptions?: IpAllowlistClient.RequestOptions): core.HttpResponsePromise<Intercom.IpAllowlist>;
private __updateIpAllowlist;
}