intercom-client
Version:
Official Node bindings to the Intercom API
31 lines (30 loc) • 1.44 kB
TypeScript
import type * as Intercom from "../index.js";
/**
* A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.
*/
export interface NewsItemRequest {
/** The title of the news item. */
title: string;
/** The news item body, which may contain HTML. */
body?: string;
/** The id of the sender of the news item. Must be a teammate on the workspace. */
sender_id: number;
/** News items will not be visible to your users in the assigned newsfeeds until they are set live. */
state?: NewsItemRequest.State;
/** When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge. */
deliver_silently?: boolean;
/** Label names displayed to users to categorize the news item. */
labels?: string[];
/** Ordered list of emoji reactions to the news item. When empty, reactions are disabled. */
reactions?: (string | undefined)[];
/** A list of newsfeed_assignments to assign to the specified newsfeed. */
newsfeed_assignments?: Intercom.NewsfeedAssignment[];
}
export declare namespace NewsItemRequest {
/** News items will not be visible to your users in the assigned newsfeeds until they are set live. */
const State: {
readonly Draft: "draft";
readonly Live: "live";
};
type State = (typeof State)[keyof typeof State];
}